pixgo-api 1.0.0

package/README.md

@@ -0,0 +1,64 @@
+# PixGo 💸
+
+Uma biblioteca simples e moderna para integração com pagamentos via Pix.
+
+## 📦 Instalação
+
+```bash
+npm install pixgo-api
+# ou
+yarn add pixgo-api
+```
+
+## 🔒 Autenticação
+
+```typescript
+import { PixGo } from "pixgo-api"
+
+const pixgo = new PixGo({ apiKey: "SUA_API_KEY_AQUI" })
+```
+
+## 💰 Criar um pagamento Pix
+
+```typescript
+pixgo.pix.create({ 
+  amount: 10,
+  customer_address: "Rua das Flores, 123, São Paulo, SP, 01234-567", // opcional
+  customer_cpf: "12345678901", // opcional
+  customer_email: "cliente@example.com", // opcional
+  customer_name: "João Silva", // opcional
+  customer_phone: "11999999999", // opcional
+  description: "Pagamento de produto", // opcional
+  external_id: "pedido_12345" // opcional
+})
+.then((res) => {
+  console.log(res)
+})
+.catch((err) => {
+  console.error(err)
+})
+```
+
+## 🔎 Consultar status do pagamento
+
+```typescript
+pixgo.pix.status({ payment_id: "019d6f17d7274b38c5f487c60a41aa" })
+.then((res) => {
+  console.log(res)
+})
+.catch((err) => {
+  console.error(err)
+})
+```
+
+## 📄 Detalhes do pagamento
+
+```typescript
+pixgo.pix.details({ payment_id: "019d6f17d7274b38c5f487c60a41aa" })
+.then((res) => {
+  console.log(res)
+})
+.catch((err) => {
+  console.error(err)
+})
+```

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { PixGo } from "./pixgo";

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PixGo = void 0;
+var pixgo_1 = require("./pixgo");
+Object.defineProperty(exports, "PixGo", { enumerable: true, get: function () { return pixgo_1.PixGo; } });

package/dist/pix.d.ts

@@ -0,0 +1,25 @@
+import { PixCreateResponse, PixStatusResponse, PixDetailsResponse } from "./types";
+interface PixCreateParams {
+    amount: number;
+    customer_name?: string;
+    customer_cpf?: string;
+    customer_email?: string;
+    customer_phone?: string;
+    customer_address?: string;
+    external_id?: string;
+    description?: string;
+}
+interface PixStatusParams {
+    payment_id: string;
+}
+export declare class Pix {
+    private config;
+    constructor(config: {
+        apiKey: string;
+        apiBase: string;
+    });
+    create(params: PixCreateParams): Promise<PixCreateResponse>;
+    details(params: PixStatusParams): Promise<PixDetailsResponse>;
+    status(params: PixStatusParams): Promise<PixStatusResponse>;
+}
+export {};

package/dist/pix.js

@@ -0,0 +1,83 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Pix = void 0;
+const axios_1 = __importDefault(require("axios"));
+class Pix {
+    config;
+    constructor(config) {
+        this.config = config;
+    }
+    async create(params) {
+        const { amount, customer_name, customer_cpf, customer_email, customer_phone, customer_address, external_id, description } = params;
+        if (!amount) {
+            throw new Error("Amount is required");
+        }
+        try {
+            const response = await axios_1.default.post(`${this.config.apiBase}/payment/create`, { amount, customer_name, customer_cpf, customer_email, customer_phone, customer_address, external_id, description }, {
+                headers: {
+                    "Content-Type": "application/json",
+                    "X-API-Key": `${this.config.apiKey}`,
+                }
+            });
+            return response.data;
+        }
+        catch (error) {
+            if (axios_1.default.isAxiosError(error) && error.response) {
+                return error.response.data;
+            }
+            else {
+                throw new Error("An unexpected error occurred");
+            }
+        }
+    }
+    async details(params) {
+        const { payment_id } = params;
+        if (!payment_id) {
+            throw new Error("Payment ID is required");
+        }
+        try {
+            const response = await axios_1.default.get(`${this.config.apiBase}/payment/${payment_id}/`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    "X-API-Key": `${this.config.apiKey}`,
+                }
+            });
+            return response.data;
+        }
+        catch (error) {
+            if (axios_1.default.isAxiosError(error) && error.response) {
+                return error.response.data;
+            }
+            else {
+                throw new Error("An unexpected error occurred");
+            }
+        }
+    }
+    async status(params) {
+        const { payment_id } = params;
+        if (!payment_id) {
+            throw new Error("Payment ID is required");
+        }
+        try {
+            const response = await axios_1.default.get(`${this.config.apiBase}/payment/${payment_id}/status`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    "X-API-Key": `${this.config.apiKey}`,
+                }
+            });
+            return response.data;
+        }
+        catch (error) {
+            if (axios_1.default.isAxiosError(error) && error.response) {
+                return error.response.data;
+            }
+            else {
+                throw new Error("An unexpected error occurred");
+            }
+        }
+    }
+}
+exports.Pix = Pix;

package/dist/pixgo.d.ts

@@ -0,0 +1,9 @@
+import { Pix } from "./pix";
+export interface PixGoConfig {
+    apiKey: string;
+}
+export declare class PixGo {
+    private config;
+    pix: Pix;
+    constructor(config: PixGoConfig);
+}

package/dist/pixgo.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PixGo = void 0;
+const pix_1 = require("./pix");
+class InternalConfig {
+    apiKey;
+    apiBase;
+    constructor(config) {
+        this.apiKey = config.apiKey;
+        this.apiBase = "https://pixgo.org/api/v1";
+    }
+}
+class PixGo {
+    config;
+    pix;
+    constructor(config) {
+        if (!config.apiKey) {
+            throw new Error("API Key is required");
+        }
+        this.config = new InternalConfig(config);
+        this.pix = new pix_1.Pix(this.config);
+    }
+}
+exports.PixGo = PixGo;

package/dist/types.d.ts

@@ -0,0 +1,46 @@
+export interface PixCreateResponse {
+    "success": boolean;
+    "data": {
+        "payment_id": string;
+        "external_id": string;
+        "amount": number;
+        "status": string;
+        "qr_code": string;
+        "qr_image_url": string;
+        "expires_at": string;
+        "created_at": string;
+    };
+}
+export interface PixStatusResponse {
+    "success": boolean;
+    "data": {
+        "payment_id": string;
+        "external_id": string;
+        "amount": number;
+        "status": string;
+        "customer_name": string;
+        "customer_cpf": string;
+        "customer_phone": string;
+        "created_at": string;
+        "updated_at": string;
+    };
+}
+export interface PixDetailsResponse {
+    "success": boolean;
+    "data": {
+        "payment_id": string;
+        "external_id": string;
+        "amount": number;
+        "status": string;
+        "customer_name": string;
+        "customer_cpf": string;
+        "customer_phone": string;
+        "customer_address": string;
+        "description": string;
+        "qr_code": string;
+        "qr_image_url": string;
+        "created_at": string;
+        "updated_at": string;
+        "expires_at": string;
+    };
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "pixgo-api",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "keywords": [
+    "pixgo",
+    "api-pix",
+    "pix"
+  ],
+  "author": "b7k3",
+  "license": "ISC",
+  "description": "Biblioteca simples para integrar com a API da PixGo",
+  "devDependencies": {
+    "@types/node": "^22.19.17",
+    "typescript": "^5.9.3"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "dependencies": {
+    "axios": "^1.15.0"
+  }
+}