@yosle/tropipayjs 0.1.9 → 0.1.11

package/interfaces/index.d.ts

@@ -1,2 +1,159 @@
-import * as countries from './countries';
-export { countries };
+import { ServerMode } from "../constants/TropipayConstants";
+export type AccountBalance = {
+    balance: number;
+    pendingIn: number;
+    pendingOut: number;
+};
+export interface TropipayConfig {
+    clientId: string;
+    clientSecret: string;
+    serverMode?: ServerMode;
+}
+export type TropipayCredentials = {
+    clientId: string;
+    clientSecret: string;
+};
+export type HookEventType = "transaction_completed" | "transaction_charged" | "transaction_guarded" | "user_signup" | "user_kyc" | "payment_in_state_change" | "payment_out_state_change" | "beneficiary_added" | "beneficiary_updated" | "beneficiary_deleted" | "transaction_new" | "transaction_preauthorized" | "transaction_pendingin" | "transaction_processing" | "transaction_error" | "transaction_bloqued" | "transaction_guarded_send" | "transaction_guarded_mediation" | "user_after_update" | "user_after_create" | "userDetail_after_create" | "userDetail_after_update" | "tpv_callback_ok" | "fraud_state_on_change";
+export type HookTargetType = "web" | "email";
+export interface UserHook {
+    event: HookEventType;
+    target: string;
+    value: string;
+}
+export interface UserHookSubscribed extends UserHook {
+    createdAt: string;
+    updatedAt: string;
+}
+export interface UserHook {
+    event: HookEventType;
+    target: string;
+    value: string;
+}
+export interface UserHookSubscribed extends UserHook {
+    createdAt: string;
+    updatedAt: string;
+}
+export interface PaymentLinkPayload {
+    reference: string;
+    concept: string;
+    favorite: boolean;
+    amount: number;
+    currency: string;
+    description: string;
+    singleUse: boolean;
+    reasonId: number;
+    expirationDays: number;
+    lang: string;
+    urlSuccess: string;
+    urlFailed: string;
+    urlNotification: string;
+    serviceDate: string;
+    client: {
+        name: string;
+        lastName: string;
+        address: string;
+        phone: string;
+        email: string;
+        countryId: number;
+        termsAndConditions: boolean;
+    };
+    directPayment: boolean;
+    paymentMethods?: string[];
+}
+export interface PaymentLink extends PaymentLinkPayload {
+    expirationDate: string;
+    hasClient: boolean;
+    updatedAt: string;
+    createdAt: string;
+    qrImage: string;
+    shortUrl: string;
+    paymentUrl: string;
+}
+export interface mediationPaymentCardConfig {
+    amount: number;
+    currency: "EUR" | "USD";
+    concept: string;
+    description: string;
+    reference: string;
+    singleUse: boolean;
+    lang: string;
+    productUrl?: string;
+    buyer: null | any;
+    seller: {
+        sellerId?: number;
+        type?: number;
+        email?: string;
+    };
+    feePercent?: number;
+    feeFixed?: number;
+    sendMail: boolean;
+}
+export type LoginResponse = {
+    access_token: string;
+    refresh_token: string;
+    token_type: "Bearer";
+    expires_in: number;
+    scope: string;
+};
+export type LoginError = {
+    error: string;
+};
+export type Country = {
+    id: number;
+    name: string;
+    sepaZone: boolean;
+    state: number;
+    slug: string;
+    slugn: number;
+    callingCode: number;
+    isDestination: boolean;
+    isRisky: boolean;
+    currentCurrency: string | null;
+    createdAt: string;
+    updatedAt: string;
+    isFavorite: boolean;
+    position: any;
+};
+export type Deposit = {
+    id: number;
+    accountNumber: string;
+    alias: string;
+    swift: string;
+    type: number;
+    country: number | null;
+    firstName: string;
+    default: null;
+    state: number;
+    userId: string;
+    countryDestinationId: number;
+    lastName: string;
+    documentNumber: number;
+    userRelationTypeId: number;
+    city: string;
+    postalCode: string;
+    address: string;
+    phone: string;
+    checked: boolean;
+    province: string;
+    beneficiaryType: number;
+    relatedUserId: null | string;
+    currency: string;
+    correspondent?: any;
+    location: any;
+    office: any;
+    officeValue: any;
+    paymentType: number;
+    paymentEntityBeneficiaryId: number;
+    paymentEntityAccountId: number;
+    verified: any;
+    paymentEntityInfo: any;
+    documentTypeId: any;
+    documentExpirationDate: Date;
+    createdAt: Date;
+    updatedAt: Date;
+    countryDestination: Country;
+};
+export type AccountDeposits = {
+    count: number;
+    rows: Deposit[];
+};

package/interfaces/paymentlink/index.d.ts

@@ -1,3 +1,50 @@
+type PaymentMethodElement = "EXT" | "TPP";
+export type PaymentMethods = Element | [PaymentMethodElement, PaymentMethodElement];
+declare enum Reasons {
+    HOUSING_ARRANGEMENT = 1,
+    FINANCIAL_AID = 2,
+    FAMILY_SUPPORT = 3,
+    TRAVEL_FUND = 4,
+    REAL_ESTATE_PURCHASE = 5,
+    FURNITURE_PURCHASE = 6,
+    EDUCATION = 7,
+    MEDICAL_EXPENSES = 8,
+    OTHER = 9,
+    DEBT_PAYMENT = 10,
+    TOURISM = 11,
+    SELF_SHIPPING = 12,
+    ACCOUNT_ACTIVATION = 13,
+    SPORTS_ACTIVITIES = 14,
+    DONATION = 15,
+    AFFILIATE_COMMISSION = 16,
+    SALARY = 17,
+    SAVINGS = 18,
+    RENT_AND_LEASING = 19,
+    SHARED_EXPENSES = 20,
+    SERVICE_PAYMENT = 21,
+    GIFT = 22,
+    CRYPTOCURRENCY_PURCHASE = 23,
+    OPERATING_EXPENSES = 24,
+    CURRENCY_EXCHANGE = 25,
+    ACCOMMODATION = 26,
+    EQUIPMENT_PURCHASE = 27,
+    CONSULTING = 28,
+    SOFTWARE_DEVELOPMENT = 29,
+    REFUND = 30,
+    PACKAGE_DELIVERY = 31,
+    PERSONAL_EXPENSES = 32,
+    INVESTMENT = 33,
+    BILL_PAYMENT = 34,
+    HOST_PAYMENT = 35,
+    TRANSPORTATION = 36,
+    LOAN = 37,
+    BONUS = 38,
+    HALLOWEEN_REMITTANCE = 39,
+    PLINK_REMITTANCE = 41,
+    R1_2023 = 78,
+    HAPPYWEEK = 79,
+    SENDING_YOU_A_KISS = 80
+}
 export interface PaymentLinkPayload {
     reference: string;
     concept: string;
@@ -6,14 +53,17 @@ export interface PaymentLinkPayload {
     currency: string;
     description: string;
     singleUse: boolean;
-    reasonId: number;
+    reasonId: Reasons;
     expirationDays: number;
     lang: string;
     urlSuccess: string;
     urlFailed: string;
     urlNotification: string;
     serviceDate: string;
-    client: {
+    /**
+     * fgfsgdfgdfgd
+     */
+    client?: {
         name: string;
         lastName: string;
         address: string;
@@ -21,9 +71,9 @@ export interface PaymentLinkPayload {
         email: string;
         countryId: number;
         termsAndConditions: boolean;
-    };
-    directPayment: boolean;
-    paymentMethods?: string[];
+    } | null;
+    directPayment?: boolean;
+    paymentMethods?: PaymentMethods;
 }
 export interface PaymentLink extends PaymentLinkPayload {
     expirationDate: string;
@@ -34,3 +84,4 @@ export interface PaymentLink extends PaymentLinkPayload {
     shortUrl: string;
     paymentUrl: string;
 }
+export {};

package/package.json

@@ -1,43 +1,43 @@
-{
-  "name": "@yosle/tropipayjs",
-  "version": "0.1.9",
-  "description": "Javascript / Typescript SDK for the Tropipay API",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "_clear": "rimraf src/dist/*",
-    "_tsc": "tsc",
-    "_make-bundle": "rollup --config",
-    "build": "yarn _clear && yarn _tsc && yarn _make-bundle"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/yosle/tropipayjs"
-  },
-  "keywords": [
-    "Javascript",
-    "Typescript",
-    "Tropipay",
-    "payments",
-    "gateway",
-    "API"
-  ],
-  "author": "Yosleivy Baez Acosta <yosle007@gmail.com>",
-  "license": "MIT",
-  "dependencies": {
-    "axios": "^0.27.2",
-    "tslib": "^2.4.0"
-  },
-  "devDependencies": {
-    "@rollup/plugin-typescript": "^8.5.0",
-    "rimraf": "^3.0.2",
-    "rollup": "^2.79.1",
-    "rollup-plugin-dts": "^4.2.2",
-    "run-s": "^0.0.0",
-    "typescript": "^5.0.4"
-  },
-  "funding": {
-    "type": "individual",
-    "url": "https://tppay.me/l94qaa3h"
-  }
-}
+{
+  "name": "@yosle/tropipayjs",
+  "version": "0.1.11",
+  "description": "Javascript / Typescript SDK for the Tropipay API",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "_clear": "rimraf src/dist/*",
+    "_tsc": "tsc",
+    "_make-bundle": "rollup --config",
+    "build": "yarn _clear && yarn _tsc && yarn _make-bundle"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/yosle/tropipayjs"
+  },
+  "keywords": [
+    "Javascript",
+    "Typescript",
+    "Tropipay",
+    "payments",
+    "gateway",
+    "API"
+  ],
+  "author": "Yosleivy Baez Acosta <yosle007@gmail.com>",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^0.27.2",
+    "tslib": "^2.4.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^8.5.0",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.79.1",
+    "rollup-plugin-dts": "^4.2.2",
+    "run-s": "^0.0.0",
+    "typescript": "^5.0.4"
+  },
+  "funding": {
+    "type": "individual",
+    "url": "https://tppay.me/l94qaa3h"
+  }
+}

package/rollup.config.js

@@ -1,23 +1,24 @@
-// Contents of the file /rollup.config.js
-import typescript from '@rollup/plugin-typescript';
-import dts from "rollup-plugin-dts";
-const config = [
-    {
-        input: 'dist/index.js',
-        output: {
-            file: 'index.js',
-            format: 'cjs',
-            sourcemap: true,
-        },
-        external: ['axios'],
-        plugins: [typescript()]
-    }, {
-        input: 'dist/index.d.ts',
-        output: {
-            file: 'index.d.ts',
-            format: 'es'
-        },
-        plugins: [dts()]
-    }
-];
-export default config;
+// Contents of the file /rollup.config.js
+import typescript from "@rollup/plugin-typescript";
+import dts from "rollup-plugin-dts";
+const config = [
+  {
+    input: "dist/index.js",
+    output: {
+      file: "index.js",
+      format: "cjs",
+      sourcemap: true,
+    },
+    external: ["axios", "crypto"],
+    plugins: [typescript()],
+  },
+  {
+    input: "dist/index.d.ts",
+    output: {
+      file: "index.d.ts",
+      format: "es",
+    },
+    plugins: [dts()],
+  },
+];
+export default config;

package/src/api/TropipayAPI.ts

@@ -0,0 +1,317 @@
+/**
+ * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
+ *
+ * @author Yosleivy Baez Acosta
+ *
+ */
+
+import axios, { Axios } from "axios";
+import {
+  TropipayConfig,
+  AccountBalance,
+  Country,
+  PaymentLinkPayload,
+  PaymentLink,
+  mediationPaymentCardConfig,
+  LoginResponse,
+  AccountDeposits,
+} from "../interfaces";
+type ServerMode = "Development" | "Production";
+import { TropipayHooks } from "../hooks/TropipayHooks";
+export class Tropipay {
+  readonly clientId: string;
+  readonly clientSecret: string;
+  public request: Axios;
+  public static accessToken: string | undefined;
+  public static refreshToken: string | undefined;
+  public serverMode: ServerMode;
+  public hooks: TropipayHooks;
+
+  constructor(config: TropipayConfig) {
+    this.clientId = config.clientId;
+    this.clientSecret = config.clientSecret;
+    this.serverMode = config.serverMode || "Development";
+    this.request = axios.create({
+      baseURL:
+        this.serverMode === "Production"
+          ? "https://www.tropipay.com"
+          : "https://tropipay-dev.herokuapp.com",
+      headers: {
+        "Content-Type": "application/json",
+        Accept: "application/json",
+        Authorization: `Bearer ${Tropipay.accessToken}`,
+      },
+    });
+    this.hooks = new TropipayHooks(this);
+  }
+
+  public async login() {
+    try {
+      const { data } = await this.request.post<LoginResponse>(
+        "/api/v2/access/token",
+        {
+          client_id: this.clientId,
+          client_secret: this.clientSecret,
+          grant_type: "client_credentials",
+          scope:
+            "ALLOW_GET_PROFILE_DATA ALLOW_PAYMENT_IN ALLOW_EXTERNAL_CHARGE KYC3_FULL_ALLOW ALLOW_PAYMENT_OUT ALLOW_MARKET_PURCHASES ALLOW_GET_BALANCE ALLOW_GET_MOVEMENT_LIST ALLOW_GET_CREDENTIAL",
+        },
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Accept: "application/json",
+          },
+        }
+      );
+
+      Tropipay.accessToken = data.access_token;
+      Tropipay.refreshToken = data.refresh_token;
+      return data;
+    } catch (error) {
+      if (axios.isAxiosError(error)) {
+        throw new Error(
+          `Could not obtain the access token from credentials  ${error}`
+        );
+      }
+      throw new Error(
+        `Could not obtain the access token from credentials  ${error}`
+      );
+    }
+  }
+
+  /**
+   * Create a paymentLink with the specified options.
+   * @param payload PaymentLinkPayload Object.
+   * @returns Promise<PaymentLink> or throws an Exception.
+   * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6ODgyNTM3OQ-create-a-new-pay-link-charge
+   */
+  async createPaymentCard(payload: PaymentLinkPayload): Promise<PaymentLink> {
+    if (!Tropipay.accessToken) {
+      await this.login();
+    }
+    try {
+      const paylink = await this.request.post("/api/v2/paymentcards", payload, {
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bearer ${Tropipay.accessToken}`,
+          Accept: "application/json",
+        },
+      });
+      return paylink.data as PaymentLink;
+    } catch (error) {
+      throw new Error(`TropipayJS - Error creating the Payment Card.`);
+    }
+  }
+
+  /**
+   * Get all deposits in this account.
+   * @returns A Promise of an Array of AccountDeposits or throws an Exception
+   * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6OTgyOTQ1Mg-get-deposit-accounts-list
+   */
+  async getDepositAccounts(): Promise<AccountDeposits[] | Error> {
+    if (!Tropipay.accessToken) {
+      await this.login();
+    }
+    try {
+      const deposits = await this.request.get("/api/v2/deposit_accounts", {
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bearer ${Tropipay.accessToken}`,
+          Accept: "application/json",
+        },
+      });
+      return deposits.data;
+    } catch (error) {
+      throw new Error(`Could not retrieve the account deposits ${error}`);
+    }
+  }
+
+  /**
+   * Get the list of all supported countries by Tropipay.
+   * @returns Array of Countries Data
+   * @see https://tpp.stoplight.io/docs/tropipay-api-doc/bfac21259e2ff-getting-users-countries-list
+   */
+  async countries(): Promise<Country[]> {
+    try {
+      const countries = await this.request.get("/api/v2/countries");
+      return countries.data;
+    } catch (error) {
+      throw new Error(`Could not retrieve the countries list`);
+    }
+  }
+  /**
+   * Get user balance
+   * @returns balance Object { balance: number, pendingIn: number, pendingOut: number }
+   */
+  async getBalance(): Promise<AccountBalance> {
+    if (!Tropipay.accessToken) {
+      await this.login();
+    }
+    try {
+      const balance = await this.request.get("/api/v2/users/balance", {
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bearer ${Tropipay.accessToken}`,
+          Accept: "application/json",
+        },
+      });
+      return balance.data;
+    } catch (error) {
+      throw new Error(
+        `TropipayJS Error - Could not retrieve the user's balance`
+      );
+    }
+  }
+
+  /**
+   * Get the list of all detination countries supported by Tropipay.
+   * Obtaining the list of valid countries to send funds to. Useful
+   * when adding new beneficiaries to some user.
+   *
+   * @returns Array of Country Objects
+   * @see https://tpp.stoplight.io/docs/tropipay-api-doc/3cfe5504f0524-getting-list-of-beneficiary-countries
+   */
+  async destinations(): Promise<Country[]> {
+    try {
+      const countries = await this.request.get(
+        "/api/v2/countries/destinations"
+      );
+      return countries.data;
+    } catch (error) {
+      throw new Error(`Could not retrieve the destination countries list`);
+    }
+  }
+
+  /**
+   * Get list of all the favorites payment links.
+   * @returns Array of account Object or throws an error
+   */
+  async favorites() {
+    if (!Tropipay.accessToken) {
+      await this.login();
+    }
+    try {
+      const favoritesList = await this.request.get(
+        "/api/v2/paymentcards/favorites",
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return favoritesList?.data?.rows;
+    } catch (error) {
+      throw new Error(`Could not retrieve favorites list ${error}`);
+    }
+  }
+
+  /**
+   * List all account movements. You can optionaly specify
+   * offset and limit params for pagination.
+   * @returns
+   */
+  async movements(offset = 0, limit = 10) {
+    if (!Tropipay.accessToken) await this.login();
+
+    try {
+      const movements = await this.request.get("/api/v2/movements", {
+        params: { limit: limit, offset: offset },
+        headers: {
+          "Content-Type": "application/json",
+          Accept: "application/json",
+          Authorization: `Bearer ${Tropipay.accessToken}`,
+        },
+      });
+      return movements.data;
+    } catch (error) {
+      throw new Error(`Could not retrieve movements list ${error}`);
+    }
+  }
+
+  /**
+   * Return profile data for current Tropipay account.
+   * @returns account object
+   */
+  async profile() {
+    if (!Tropipay.accessToken) await this.login();
+    try {
+      const profile = await this.request.get("/api/users/profile");
+      return profile.data;
+    } catch (error) {
+      throw new Error(`Could not retrieve movements list ${error}`);
+    }
+  }
+
+  /**
+   * Obtain current Tropipay conversion rate. For example USD to EUR
+   * targetCurrency must be 'EUR'
+   * @param originCurrency Target currency code supported by Tropipay.
+   * @param targetCurrency Must be 'EUR'? (not documented by Tropipay)
+   * @returns Conversion rate (number)
+   * @see https://tpp.stoplight.io/docs/tropipay-api-doc/85163f6f28b23-get-rate
+   */
+  async rates(
+    originCurrency: string,
+    targetCurrency: string = "EUR"
+  ): Promise<number | Error> {
+    if (!Tropipay.accessToken) {
+      await this.login();
+    }
+    try {
+      const rates = await this.request.post(
+        "/api/v2/movements/get_rate",
+        {
+          currencyFrom: originCurrency,
+          currencyTo: targetCurrency,
+        },
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Accept: "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+          },
+        }
+      );
+      return rates.data.rate;
+    } catch (error) {
+      throw new Error(`Could not retrieve rates ${error}`);
+    }
+  }
+
+  /**
+   * (ONLY in Bussiness Accounts)
+   * An escrow payment link. This allows a payment to be made to persons
+   * belonging or not to the TropiPay platform with the particularity
+   * that the payment will be held in custody or retained until it is
+   * released with the approval of the payer.
+   * @see https://tpp.stoplight.io/docs/tropipay-api-doc/12a128ff971e4-creating-a-mediation-payment-card
+   * @param config Payload with the payment details
+   */
+  async createMediationPaymentCard(
+    config: mediationPaymentCardConfig
+  ): Promise<PaymentLink> {
+    if (!Tropipay.accessToken) await this.login();
+    try {
+      const mediation = await this.request.post(
+        "/api/v2/paymentcards/mediation",
+        config,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return mediation.data as PaymentLink;
+    } catch (error) {
+      throw new Error(`Could not create mediation payment card`);
+    }
+  }
+}
+
+export class ClientSideUtils {
+  constructor(tropipayInstance: Tropipay) {}
+}