@yosle/tropipayjs 0.1.7 → 0.1.9

package/src/index.ts

@@ -7,27 +7,34 @@
 
 import axios, { Axios } from "axios";
 import { PaymentLink, PaymentLinkPayload } from './interfaces/paymentlink'
-
+import { mediationPaymentCardConfig } from "./interfaces/mediation";
 
 type ServerMode = 'Development' | 'Production'
 
+interface TropipayConfig {
+    clientId: string;
+    clientSecret: string;
+    serverMode?: ServerMode;
+}
+
+type AccountBalance = {
+    balance: number,
+    pendingIn: number,
+    pendingOut: number
+}
 
 export class Tropipay {
-    readonly clientId: string;
-    readonly clientSecret: string;
+    protected clientId: string;
+    protected clientSecret: string;
     protected request: Axios;
-    protected accessToken: string | undefined;
-    protected refreshToken: string | undefined;
+    protected static accessToken: string | undefined;
+    protected static refreshToken: string | undefined;
     protected serverMode: ServerMode;
 
-    constructor(
-        client_id: string,
-        client_secret: string,
-        server_mode: ServerMode = 'Development') {
-        this.clientId = client_id;
-        this.clientSecret = client_secret
-        this.serverMode = server_mode
-
+    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'
@@ -35,10 +42,9 @@ export class Tropipay {
             headers: {
                 'Content-Type': 'application/json',
                 Accept: 'application/json',
-                Authorization: `Bearer ${this.accessToken}`,
-
-            }   
-        })
+                Authorization: `Bearer ${Tropipay.accessToken}`,
+            }
+        });
     }
 
 
@@ -50,20 +56,20 @@ export class Tropipay {
                 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',
-                // }
-            })
+                headers: {
+                    'Content-Type': 'application/json',
+                    Accept: 'application/json',
+                }
+            });
 
-            this.accessToken = data.access_token
-            this.refreshToken = data.refresh_token
+            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}`);
+            }
+            throw new Error(`Could not obtain the access token from credentials  ${error}`);
 
         }
     }
@@ -74,22 +80,21 @@ export class Tropipay {
      * @returns Promise<PaymentLink> or throws an Exception.
      * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6ODgyNTM3OQ-create-a-new-pay-link-charge
      */
-    async createPayLink(payload: PaymentLinkPayload): Promise<PaymentLink> {
-        if (!this.accessToken) {
+    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 ${this.accessToken}`,
-                    // Accept: 'application/json'
+                    'Content-Type': 'application/json',
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: 'application/json'
                 }
             })
             return paylink.data as PaymentLink
         } catch (error) {
             throw new Error(`Could not obtain the access token with the given credentials.`);
-
         }
     }
 
@@ -98,15 +103,21 @@ export class Tropipay {
      * @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 (!this.accessToken) {
+    async getDepositAccounts(): Promise<AccountDeposits[] | Error> {
+        if (!Tropipay.accessToken) {
             await this.login()
         }
         try {
-            const deposits  = await this.request.get('/api/v2/deposit_accounts',{            }) 
+            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}`);    
+            throw new Error(`Could not retrieve the account deposits ${error}`);
         }
     }
 
@@ -115,16 +126,35 @@ export class Tropipay {
      * @returns Array of Countries Data
      * @see https://tpp.stoplight.io/docs/tropipay-api-doc/bfac21259e2ff-getting-users-countries-list
      */
-    async countries(): Promise<Country[] > {
-        
+    async countries(): Promise<Country[]> {
         try {
-            const countries  = await this.request.get('/api/v2/countries') 
+            const countries = await this.request.get('/api/v2/countries')
             return countries.data
         } catch (error) {
-            throw new Error(`Could not retrieve the countries list`);    
+            throw new Error(`TropipayJS 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. 
@@ -136,28 +166,32 @@ export class Tropipay {
      */
     async destinations(): Promise<Country[]> {
         try {
-            const countries  = await this.request.get('/api/v2/countries/destinations') 
+            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`);    
+            throw new Error(`Could not retrieve the destination countries list`);
         }
     }
 
     /**
-     * Get list of all the favorites accounts. This endpoint is not documented
-     * in the official Tropipay documentation.
-     * @returns 
+     * Get list of all the favorites payment links. 
+     * @returns Array of account Object or throws an error
      */
-    async favorites(){
-        if (!this.accessToken) {
+    async favorites() {
+        if (!Tropipay.accessToken) {
             await this.login()
         }
         try {
-            const favoritesList  = await this.request.get('/api/v2/paymentcards/favorites') 
-            console.log(favoritesList)
-            return favoritesList.data 
-        } catch (error) {            
-            throw new Error(`Could not retrieve favorites list ${error}`);    
+            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}`);
         }
     }
 
@@ -166,41 +200,39 @@ export class Tropipay {
      * offset and limit params for pagination.
      * @returns 
      */
-    async movements(offset = 0 , limit = 10){
-        if (!this.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 ${this.accessToken}`,
+    async movements(offset = 0, limit = 10) {
+        if (!Tropipay.accessToken) await this.login()
 
-            } }) 
-            return movements.data 
+        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`);    
+            throw new Error(`Could not retrieve movements list ${error}`);
         }
-   
     }
 
     /**
      * Return profile data for this account.
      * @returns 
      */
-    async profile(){
-        if (!this.accessToken) {
-            await this.login()
-        }
+    async profile() {
+        if (!Tropipay.accessToken) await this.login();
         try {
-            const profile  = await this.request.get('/api/users/profile') 
-            return profile.data 
+            const profile = await this.request.get('/api/users/profile')
+            return profile.data
         } catch (error) {
-            throw new Error(`Could not retrieve movements list ${error}`);    
+            throw new Error(`Could not retrieve movements list ${error}`);
         }
     }
+
     /**
      * Obtain current Tropipay conversion rate. For example USD to EUR
      * targetCurrency must be 'EUR'
@@ -209,28 +241,56 @@ export class 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 (!this.accessToken) {
+    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 ${this.accessToken}`,
-
-        } })  
-        return rates.data.rate 
-    } catch (error) {
-        throw new Error(`Could not retrieve rates ${error}`);    
+        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 generate mediation paymentCard ${error}`);
+        }
+
+
     }
-        
-    } 
 
 }
 

package/src/interfaces/mediation/index.ts

@@ -0,0 +1,23 @@
+
+/**
+ * 
+ */
+export interface mediationPaymentCardConfig {
+    amount: number //5000,
+    currency: "EUR" | "USD",
+    concept: string //Celular,
+    description: string,
+    reference: string, //458424548,
+    singleUse: boolean,
+    lang: string// es,
+    productUrl?: string,
+    buyer: null | any //null,
+    seller: {
+        sellerId?: number,
+        type?: number,
+        email?: string
+    },
+    feePercent?: number,//in cents
+    feeFixed?: number,
+    sendMail: boolean
+}

package/docs/README.MD

@@ -1,4 +0,0 @@
-Documentation
-=============
-
-This will be added eventually.