@sphoq/payments 0.4.0 → 0.6.0

package/dist/client.d.ts

@@ -1,8 +1,8 @@
-import type { SphoqPaymentsOptions, CreateChargeOptions, Charge, GetChargeOptions, CancelChargeOptions, CancelChargeResult, VerifyWebhookOptions } from "./types.js";
+import type { SphoqPaymentsOptions, CreateChargeOptions, Charge, GetChargeOptions, CancelChargeOptions, CancelChargeResult, CreateRefundOptions, Refund, GetRefundOptions, VerifyWebhookOptions } from "./types.js";
 /**
  * Sphoq Payments SDK client.
  *
- * Provides methods for creating and managing PIX charges, and verifying webhook signatures.
+ * Provides methods for creating and managing charges, and verifying webhook signatures.
  * Zero dependencies — uses native `fetch` and Web Crypto API.
  *
  * @example Basic setup
@@ -15,20 +15,20 @@ import type { SphoqPaymentsOptions, CreateChargeOptions, Charge, GetChargeOption
  * });
  * ```
  *
- * @example Create a PIX charge and display QR code
+ * @example Create a charge and display checkout image
  * ```ts
  * const charge = await sphoq.charges.create({
  *   amount: 49.90,
  *   description: "Premium Plan",
  *   externalId: "order_123",
- *   customer: { name: "João Silva", cpf: "12345678900" },
+ *   customer: { name: "João Silva", taxId: "12345678900" },
  * });
  *
- * // Show QR code to user (base64 PNG)
- * document.getElementById("qr").src = `data:image/png;base64,${charge.qrCode}`;
+ * // Show checkout image to user (base64 PNG)
+ * document.getElementById("qr").src = `data:image/png;base64,${charge.checkoutImage}`;
  *
- * // Or show the copy-paste PIX string
- * console.log(charge.pixCopiaECola);
+ * // Or show the copy-paste payment code
+ * console.log(charge.paymentCode);
  * ```
  *
  * @example Convex integration — reactive payment status
@@ -72,7 +72,7 @@ export declare class SphoqPayments {
     private readonly apiKey;
     private readonly baseUrl;
     /**
-     * Client for creating, querying, and cancelling PIX charges.
+     * Client for creating, querying, and cancelling charges.
      *
      * @example
      * ```ts
@@ -90,6 +90,22 @@ export declare class SphoqPayments {
      * ```
      */
     readonly charges: ChargesClient;
+    /**
+     * Client for creating and querying refunds.
+     *
+     * @example
+     * ```ts
+     * // Create a refund for a paid charge
+     * const refund = await sphoq.refunds.create({
+     *   id: charge.id,
+     *   reason: "Customer requested cancellation",
+     * });
+     *
+     * // Query a refund
+     * const status = await sphoq.refunds.get({ id: refund.id });
+     * ```
+     */
+    readonly refunds: RefundsClient;
     /**
      * Creates a new Sphoq Payments client.
      *
@@ -155,14 +171,14 @@ declare class ChargesClient {
     private readonly baseUrl;
     constructor(apiKey: string, baseUrl: string);
     /**
-     * Create a new PIX charge.
+     * Create a new charge.
      *
-     * Generates a PIX QR code and copy-paste string that the customer can use to pay.
+     * Generates a payment code and checkout image that the customer can use to pay.
      * The charge starts with `status: "pending"` and transitions to `"paid"` when
      * the customer completes the payment.
      *
      * @param options - Charge details (amount, description, customer info, etc.).
-     * @returns The created charge with QR code data.
+     * @returns The created charge with payment data.
      * @throws {@link SphoqApiError} if the API returns an error (invalid params, rate limit, etc.).
      *
      * @example Simple charge
@@ -171,7 +187,7 @@ declare class ChargesClient {
      *   amount: 29.90,
      *   description: "Monthly subscription",
      * });
-     * console.log(charge.pixCopiaECola); // PIX copy-paste string
+     * console.log(charge.paymentCode); // Copy-paste payment string
      * ```
      *
      * @example Full options
@@ -183,7 +199,7 @@ declare class ChargesClient {
      *   customer: {
      *     name: "Maria Santos",
      *     email: "maria@example.com",
-     *     cpf: "12345678900",
+     *     taxId: "12345678900",
      *   },
      *   expirationSeconds: 1800, // 30 minutes
      *   metadata: { planId: "annual", coupon: "SAVE20" },
@@ -213,10 +229,10 @@ declare class ChargesClient {
      */
     get(options: GetChargeOptions): Promise<Charge>;
     /**
-     * Cancel a pending PIX charge.
+     * Cancel a pending charge.
      *
      * Only charges with `status: "pending"` can be cancelled.
-     * After cancellation, the QR code is invalidated and the charge
+     * After cancellation, the payment code is invalidated and the charge
      * cannot be paid.
      *
      * @param options - The charge ID to cancel.
@@ -233,4 +249,55 @@ declare class ChargesClient {
     cancel(options: CancelChargeOptions): Promise<CancelChargeResult>;
     private request;
 }
+declare class RefundsClient {
+    private readonly apiKey;
+    private readonly baseUrl;
+    constructor(apiKey: string, baseUrl: string);
+    /**
+     * Create a refund for a paid charge.
+     *
+     * Only charges with `status: "paid"` can be refunded. If `amount` is omitted,
+     * the full charge amount is refunded. Partial refunds are supported.
+     *
+     * @param options - Refund details (charge ID, optional amount and reason).
+     * @returns The created refund with initial status.
+     * @throws {@link SphoqApiError} with status 400 if the charge is not paid or amount exceeds refundable balance.
+     * @throws {@link SphoqApiError} with status 404 if the charge is not found.
+     *
+     * @example Full refund
+     * ```ts
+     * const refund = await sphoq.refunds.create({
+     *   id: charge.id,
+     *   reason: "Order cancelled",
+     * });
+     * ```
+     *
+     * @example Partial refund
+     * ```ts
+     * const refund = await sphoq.refunds.create({
+     *   id: charge.id,
+     *   amount: 15.00,
+     *   reason: "Partial return",
+     * });
+     * ```
+     */
+    create(options: CreateRefundOptions): Promise<Refund>;
+    /**
+     * Retrieve an existing refund by its ID.
+     *
+     * @param options - Lookup criteria (refund ID).
+     * @returns The refund object with current status.
+     * @throws {@link SphoqApiError} with status 404 if the refund is not found.
+     *
+     * @example
+     * ```ts
+     * const refund = await sphoq.refunds.get({ id: "ref_abc123" });
+     * if (refund.status === "completed") {
+     *   console.log("Refund completed at", new Date(refund.completedAt!));
+     * }
+     * ```
+     */
+    get(options: GetRefundOptions): Promise<Refund>;
+    private request;
+}
 export {};

package/dist/client.js

@@ -3,7 +3,7 @@ const DEFAULT_BASE_URL = "https://your-convex-deployment.convex.site";
 /**
  * Sphoq Payments SDK client.
  *
- * Provides methods for creating and managing PIX charges, and verifying webhook signatures.
+ * Provides methods for creating and managing charges, and verifying webhook signatures.
  * Zero dependencies — uses native `fetch` and Web Crypto API.
  *
  * @example Basic setup
@@ -16,20 +16,20 @@ const DEFAULT_BASE_URL = "https://your-convex-deployment.convex.site";
  * });
  * ```
  *
- * @example Create a PIX charge and display QR code
+ * @example Create a charge and display checkout image
  * ```ts
  * const charge = await sphoq.charges.create({
  *   amount: 49.90,
  *   description: "Premium Plan",
  *   externalId: "order_123",
- *   customer: { name: "João Silva", cpf: "12345678900" },
+ *   customer: { name: "João Silva", taxId: "12345678900" },
  * });
  *
- * // Show QR code to user (base64 PNG)
- * document.getElementById("qr").src = `data:image/png;base64,${charge.qrCode}`;
+ * // Show checkout image to user (base64 PNG)
+ * document.getElementById("qr").src = `data:image/png;base64,${charge.checkoutImage}`;
  *
- * // Or show the copy-paste PIX string
- * console.log(charge.pixCopiaECola);
+ * // Or show the copy-paste payment code
+ * console.log(charge.paymentCode);
  * ```
  *
  * @example Convex integration — reactive payment status
@@ -73,7 +73,7 @@ export class SphoqPayments {
     apiKey;
     baseUrl;
     /**
-     * Client for creating, querying, and cancelling PIX charges.
+     * Client for creating, querying, and cancelling charges.
      *
      * @example
      * ```ts
@@ -91,6 +91,22 @@ export class SphoqPayments {
      * ```
      */
     charges;
+    /**
+     * Client for creating and querying refunds.
+     *
+     * @example
+     * ```ts
+     * // Create a refund for a paid charge
+     * const refund = await sphoq.refunds.create({
+     *   id: charge.id,
+     *   reason: "Customer requested cancellation",
+     * });
+     *
+     * // Query a refund
+     * const status = await sphoq.refunds.get({ id: refund.id });
+     * ```
+     */
+    refunds;
     /**
      * Creates a new Sphoq Payments client.
      *
@@ -108,6 +124,7 @@ export class SphoqPayments {
         this.apiKey = options.apiKey;
         this.baseUrl = (options.baseUrl ?? DEFAULT_BASE_URL).replace(/\/$/, "");
         this.charges = new ChargesClient(this.apiKey, this.baseUrl);
+        this.refunds = new RefundsClient(this.apiKey, this.baseUrl);
     }
     /**
      * Verify a webhook signature to ensure the request came from Sphoq.
@@ -182,14 +199,14 @@ class ChargesClient {
         this.baseUrl = baseUrl;
     }
     /**
-     * Create a new PIX charge.
+     * Create a new charge.
      *
-     * Generates a PIX QR code and copy-paste string that the customer can use to pay.
+     * Generates a payment code and checkout image that the customer can use to pay.
      * The charge starts with `status: "pending"` and transitions to `"paid"` when
      * the customer completes the payment.
      *
      * @param options - Charge details (amount, description, customer info, etc.).
-     * @returns The created charge with QR code data.
+     * @returns The created charge with payment data.
      * @throws {@link SphoqApiError} if the API returns an error (invalid params, rate limit, etc.).
      *
      * @example Simple charge
@@ -198,7 +215,7 @@ class ChargesClient {
      *   amount: 29.90,
      *   description: "Monthly subscription",
      * });
-     * console.log(charge.pixCopiaECola); // PIX copy-paste string
+     * console.log(charge.paymentCode); // Copy-paste payment string
      * ```
      *
      * @example Full options
@@ -210,7 +227,7 @@ class ChargesClient {
      *   customer: {
      *     name: "Maria Santos",
      *     email: "maria@example.com",
-     *     cpf: "12345678900",
+     *     taxId: "12345678900",
      *   },
      *   expirationSeconds: 1800, // 30 minutes
      *   metadata: { planId: "annual", coupon: "SAVE20" },
@@ -266,10 +283,10 @@ class ChargesClient {
         return this.request("/v1/charges/get", body);
     }
     /**
-     * Cancel a pending PIX charge.
+     * Cancel a pending charge.
      *
      * Only charges with `status: "pending"` can be cancelled.
-     * After cancellation, the QR code is invalidated and the charge
+     * After cancellation, the payment code is invalidated and the charge
      * cannot be paid.
      *
      * @param options - The charge ID to cancel.
@@ -304,3 +321,82 @@ class ChargesClient {
         return data;
     }
 }
+class RefundsClient {
+    apiKey;
+    baseUrl;
+    constructor(apiKey, baseUrl) {
+        this.apiKey = apiKey;
+        this.baseUrl = baseUrl;
+    }
+    /**
+     * Create a refund for a paid charge.
+     *
+     * Only charges with `status: "paid"` can be refunded. If `amount` is omitted,
+     * the full charge amount is refunded. Partial refunds are supported.
+     *
+     * @param options - Refund details (charge ID, optional amount and reason).
+     * @returns The created refund with initial status.
+     * @throws {@link SphoqApiError} with status 400 if the charge is not paid or amount exceeds refundable balance.
+     * @throws {@link SphoqApiError} with status 404 if the charge is not found.
+     *
+     * @example Full refund
+     * ```ts
+     * const refund = await sphoq.refunds.create({
+     *   id: charge.id,
+     *   reason: "Order cancelled",
+     * });
+     * ```
+     *
+     * @example Partial refund
+     * ```ts
+     * const refund = await sphoq.refunds.create({
+     *   id: charge.id,
+     *   amount: 15.00,
+     *   reason: "Partial return",
+     * });
+     * ```
+     */
+    async create(options) {
+        const body = {
+            id: options.id,
+        };
+        if (options.amount !== undefined)
+            body.amount = options.amount;
+        if (options.reason)
+            body.reason = options.reason;
+        return this.request("/v1/refunds", body);
+    }
+    /**
+     * Retrieve an existing refund by its ID.
+     *
+     * @param options - Lookup criteria (refund ID).
+     * @returns The refund object with current status.
+     * @throws {@link SphoqApiError} with status 404 if the refund is not found.
+     *
+     * @example
+     * ```ts
+     * const refund = await sphoq.refunds.get({ id: "ref_abc123" });
+     * if (refund.status === "completed") {
+     *   console.log("Refund completed at", new Date(refund.completedAt!));
+     * }
+     * ```
+     */
+    async get(options) {
+        return this.request("/v1/refunds/get", { id: options.id });
+    }
+    async request(path, body) {
+        const response = await fetch(`${this.baseUrl}${path}`, {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+                Authorization: `Bearer ${this.apiKey}`,
+            },
+            body: JSON.stringify(body),
+        });
+        const data = await response.json();
+        if (!response.ok) {
+            throw new SphoqApiError(data.error ?? "Request failed", response.status, data);
+        }
+        return data;
+    }
+}

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export { SphoqPayments } from "./client.js";
 export { SphoqApiError } from "./types.js";
-export type { SphoqPaymentsOptions, ChargeItem, ChargeFee, CreateChargeOptions, Charge, GetChargeOptions, CancelChargeOptions, CancelChargeResult, WebhookPayload, VerifyWebhookOptions, } from "./types.js";
+export type { SphoqPaymentsOptions, ChargeItem, ChargeFee, CreateChargeOptions, Charge, GetChargeOptions, CancelChargeOptions, CancelChargeResult, CreateRefundOptions, Refund, GetRefundOptions, WebhookPayload, VerifyWebhookOptions, } from "./types.js";

package/dist/types.d.ts

@@ -79,7 +79,7 @@ export interface ChargeItem {
     imageUrl?: string;
 }
 /**
- * Options for creating a new PIX charge.
+ * Options for creating a new charge.
  *
  * @example Simple charge
  * ```ts
@@ -90,7 +90,7 @@ export interface ChargeItem {
  *   customer: {
  *     name: "João Silva",
  *     email: "joao@example.com",
- *     cpf: "12345678900",
+ *     taxId: "12345678900",
  *   },
  *   expirationSeconds: 3600, // 1 hour
  *   metadata: { planId: "premium", userId: "usr_abc" },
@@ -111,8 +111,8 @@ export interface ChargeItem {
  */
 export interface CreateChargeOptions {
     /**
-     * Charge amount in BRL (Brazilian Real).
-     * Must be greater than 0. Use decimal notation (e.g., `29.90` for R$ 29,90).
+     * Charge amount. Must be greater than 0.
+     * Use decimal notation (e.g., `29.90`).
      */
     amount: number;
     /** Human-readable description shown to the customer. */
@@ -131,12 +131,19 @@ export interface CreateChargeOptions {
         name?: string;
         /** Customer's email address. */
         email?: string;
-        /** Customer's CPF (Brazilian tax ID, 11 digits, no formatting). */
-        cpf?: string;
+        /** Customer's tax ID (e.g., CPF in Brazil, 11 digits, no formatting). */
+        taxId?: string;
+        /**
+         * Your own identifier for this customer.
+         * Useful for mapping charges to users in your system.
+         *
+         * @example "usr_abc123"
+         */
+        externalId?: string;
     };
     /**
-     * Time in seconds until the PIX charge expires.
-     * After expiration, the QR code can no longer be paid.
+     * Time in seconds until the charge expires.
+     * After expiration, the payment code can no longer be used.
      *
      * @default 3600 (1 hour)
      */
@@ -145,7 +152,7 @@ export interface CreateChargeOptions {
      * Line items included in this charge.
      *
      * When provided, the sum of `quantity * unitPrice` across all items **must**
-     * exactly equal the `amount` field (within R$ 0.01 tolerance). The API rejects
+     * exactly equal the `amount` field (within 0.01 tolerance). The API rejects
      * the request if the totals don't match.
      *
      * Items are stored with the charge and included in webhook payloads,
@@ -201,7 +208,7 @@ export interface ChargeFee {
     amount: number;
 }
 /**
- * A PIX charge object returned by the Sphoq API.
+ * A charge object returned by the Sphoq API.
  *
  * @example
  * ```ts
@@ -210,16 +217,16 @@ export interface ChargeFee {
  *   description: "Monthly subscription",
  * });
  *
- * // Display QR code to user
- * console.log(charge.qrCode);        // Base64-encoded QR code image
- * console.log(charge.pixCopiaECola); // PIX copy-paste string
+ * // Display checkout image to user
+ * console.log(charge.checkoutImage); // Base64-encoded checkout image (QR code, barcode, etc.)
+ * console.log(charge.paymentCode);   // Copy-paste payment string
  * console.log(charge.status);        // "pending"
  *
  * // After payment, query the charge
  * const paid = await sphoq.charges.get({ id: charge.id });
- * console.log(paid.status);      // "paid"
- * console.log(paid.paidAt);      // Unix timestamp in ms
- * console.log(paid.endToEndId);  // Central Bank end-to-end ID
+ * console.log(paid.status);            // "paid"
+ * console.log(paid.paidAt);            // Unix timestamp in ms
+ * console.log(paid.providerPaymentId); // Provider's payment confirmation ID
  * ```
  */
 export interface Charge {
@@ -227,50 +234,54 @@ export interface Charge {
     id: string;
     /** Your external ID, if provided when creating the charge. */
     externalId?: string;
-    /** Charge amount in BRL. */
+    /** Charge amount. */
     amount: number;
-    /**
-     * Currency code. Always `"BRL"` (Brazilian Real).
-     */
+    /** Currency code (e.g., `"BRL"`, `"USD"`). */
     currency: string;
     /** Human-readable description of the charge. */
     description: string;
     /**
      * Current status of the charge.
      *
-     * - `"pending"` — Awaiting payment. QR code is active.
-     * - `"paid"` — Payment confirmed by the bank.
-     * - `"expired"` — QR code expired before payment.
+     * - `"pending"` — Awaiting payment.
+     * - `"paid"` — Payment confirmed by the provider.
+     * - `"expired"` — Charge expired before payment.
      * - `"cancelled"` — Charge was cancelled via the API.
      */
     status: "pending" | "paid" | "expired" | "cancelled";
-    /** PIX transaction ID (txid). Unique identifier in the Brazilian PIX system. */
-    txid: string;
+    /** Provider's charge identifier (e.g., PIX txid, Stripe charge_id). */
+    providerChargeId: string;
+    /** Payment method used (e.g., `"pix"`). */
+    paymentMethod: string;
+    /** Payment provider (e.g., `"efibank"`). */
+    provider: string;
     /**
-     * PIX "copia e cola" (copy-paste) string.
-     * The customer can paste this into their banking app to pay.
+     * Copy-paste payment string for the customer
+     * (e.g., PIX copia-e-cola, Boleto barcode digits).
      */
-    pixCopiaECola?: string;
+    paymentCode?: string;
     /**
-     * Base64-encoded PNG image of the PIX QR code.
-     * Display this to the customer for scanning.
+     * Base64-encoded checkout image (e.g., QR code, barcode).
+     * Display this to the customer.
      */
-    qrCode?: string;
+    checkoutImage?: string;
     /** Customer name, if provided. */
     customerName?: string;
     /** Customer email, if provided. */
     customerEmail?: string;
+    /** Your own customer identifier, if provided. */
+    customerExternalId?: string;
     /**
      * Unix timestamp (milliseconds) when the payment was confirmed.
      * Only present when `status` is `"paid"`.
      */
     paidAt?: number;
     /**
-     * Central Bank end-to-end ID for the PIX transaction.
+     * Provider's payment confirmation ID.
      * Only present when `status` is `"paid"`.
-     * Can be used for reconciliation with bank statements.
+     * Can be used for reconciliation with bank/provider statements.
      */
-    endToEndId?: string;
+    providerPaymentId?: string;
     /**
      * Line items included in the charge, if provided at creation.
      * Returned as-is from the API. Useful for order fulfillment.
@@ -287,24 +298,24 @@ export interface Charge {
      */
     fees: ChargeFee[];
     /**
-     * Sum of all fee amounts in BRL.
+     * Sum of all fee amounts.
      * Equal to `fees.reduce((sum, f) => sum + f.amount, 0)`.
      */
     totalFees: number;
     /**
-     * Amount after fees in BRL.
+     * Amount after fees.
      * Equal to `amount - totalFees`.
      */
     netAmount: number;
     /**
      * The environment this charge was created in.
-     * - `"production"` — Real PIX charge.
-     * - `"development"` — EfiBank sandbox charge (no real money).
+     * - `"production"` — Real charge.
+     * - `"development"` — Sandbox charge (no real money).
      */
     environment?: "production" | "development";
     /** Unix timestamp (milliseconds) when the charge was created. */
     createdAt: number;
-    /** Unix timestamp (milliseconds) when the PIX QR code expires. */
+    /** Unix timestamp (milliseconds) when the charge expires. */
     expiresAt: number;
 }
 /**
@@ -391,8 +402,8 @@ export interface WebhookPayload {
     /**
      * The event type.
      *
-     * - `"charge.paid"` — Customer completed the PIX payment.
-     * - `"charge.expired"` — QR code expired before payment.
+     * - `"charge.paid"` — Customer completed the payment.
+     * - `"charge.expired"` — Charge expired before payment.
      * - `"charge.cancelled"` — Charge was cancelled via the API.
      */
     type: "charge.paid" | "charge.expired" | "charge.cancelled";
@@ -414,6 +425,91 @@ export interface VerifyWebhookOptions {
     /** Your webhook endpoint secret from the Sphoq dashboard. */
     secret: string;
 }
+/**
+ * Options for creating a refund for a charge.
+ *
+ * @example Full refund
+ * ```ts
+ * const refund = await sphoq.refunds.create({
+ *   id: "ch_abc123", // Sphoq charge ID
+ *   reason: "Customer requested cancellation",
+ * });
+ * console.log(refund.status); // "pending"
+ * ```
+ *
+ * @example Partial refund
+ * ```ts
+ * const refund = await sphoq.refunds.create({
+ *   id: "ch_abc123",
+ *   amount: 15.00, // Partial refund amount
+ *   reason: "Partial return",
+ * });
+ * ```
+ */
+export interface CreateRefundOptions {
+    /** Sphoq charge ID to refund. The charge must have `status: "paid"`. */
+    id: string;
+    /**
+     * Refund amount. If omitted, defaults to the full charge amount.
+     * Must be greater than 0 and less than or equal to the refundable amount.
+     */
+    amount?: number;
+    /** Reason for the refund. */
+    reason?: string;
+}
+/**
+ * A refund object returned by the Sphoq API.
+ *
+ * Refunds are processed asynchronously by the payment provider.
+ * Use webhooks or poll the refund status to track completion.
+ *
+ * @example
+ * ```ts
+ * const refund = await sphoq.refunds.create({ id: chargeId });
+ * console.log(refund.id);     // Sphoq refund ID
+ * console.log(refund.status); // "pending" | "processing" | "completed" | "failed"
+ * ```
+ */
+export interface Refund {
+    /** Unique Sphoq refund ID. */
+    id: string;
+    /** The charge ID this refund belongs to. */
+    chargeId: string;
+    /** Refund amount. */
+    amount: number;
+    /** Currency code (e.g., `"BRL"`). */
+    currency: string;
+    /**
+     * Current status of the refund.
+     *
+     * - `"pending"` — Refund created, waiting to be sent to the provider.
+     * - `"processing"` — Sent to the provider, awaiting confirmation.
+     * - `"completed"` — Refund confirmed by the provider.
+     * - `"failed"` — Refund failed (see `failureReason`).
+     */
+    status: "pending" | "processing" | "completed" | "failed";
+    /** Reason the refund failed, if `status` is `"failed"`. */
+    failureReason?: string;
+    /** Reason for the refund, if provided. */
+    reason?: string;
+    /** Unix timestamp (milliseconds) when the refund was created. */
+    createdAt: number;
+    /** Unix timestamp (milliseconds) when the refund was completed. */
+    completedAt?: number;
+}
+/**
+ * Options for retrieving an existing refund.
+ *
+ * @example
+ * ```ts
+ * const refund = await sphoq.refunds.get({ id: "ref_abc123" });
+ * console.log(refund.status); // "completed"
+ * ```
+ */
+export interface GetRefundOptions {
+    /** Sphoq refund ID. */
+    id: string;
+}
 /**
  * Error thrown when the Sphoq API returns a non-2xx response.
  *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sphoq/payments",
-  "version": "0.4.0",
-  "description": "Sphoq Payments SDK — integrate PIX payment processing into your app",
+  "version": "0.6.0",
+  "description": "Sphoq Payments SDK — integrate payment processing into your app",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,12 +11,21 @@
       "import": "./dist/index.js"
     }
   },
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsc",
     "dev": "tsc --watch"
   },
-  "keywords": ["sphoq", "pix", "payments", "brazil", "efibank", "convex"],
+  "keywords": [
+    "sphoq",
+    "pix",
+    "payments",
+    "brazil",
+    "efibank",
+    "convex"
+  ],
   "license": "MIT",
   "devDependencies": {
     "typescript": "^5.9.0"