@yosle/tropipayjs 0.1.13 → 0.1.15

package/README.md

@@ -1,15 +1,13 @@
-TropipayJS - Typescript/Javascript SDK for Tropipay Payments API
-===========
+# TropipayJS - Typescript/Javascript SDK for Tropipay Payments API
 
 ![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
-![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white) 
+![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
 ![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
 ![Next JS](https://img.shields.io/badge/Next-black?style=for-the-badge&logo=next.js&logoColor=white)
 ![RollupJS](https://img.shields.io/badge/RollupJS-ef3335?style=for-the-badge&logo=rollup.js&logoColor=white)
 
 TropiPay is an electronic wallet that allows you to execute the most common financial operations of the day to day. This is SDK for Typescript and Javacript that helps you build integrations with the Tropipay platform in an easier way. Can save you a lot of time and effort implementing all the API features. You can use this library with CommonJS system (node + express) or ES6 module system (NextJS).
 
-
 # Table of Contents
 
 - [TropipayJS - Typescript/Javascript SDK for Tropipay Payments API](#tropipayjs---typescriptjavascript-sdk-for-tropipay-payments-api)
@@ -29,7 +27,7 @@ TropiPay is an electronic wallet that allows you to execute the most common fina
 
 This library is a community effort. Tropipay may make some changes on the API specification. Use the [test environment](https://tropipay-dev.herokuapp.com) to make sure everything is working as expected.
 
-**Note:** This library is provided as-is and serves as a client for the Tropipay API. While every effort has been made to ensure the accuracy and reliability of the library, Tropipay is solely responsible for maintaining and updating the API documentation. 
+**Note:** This library is provided as-is and serves as a client for the Tropipay API. While every effort has been made to ensure the accuracy and reliability of the library, Tropipay is solely responsible for maintaining and updating the API documentation.
 
 The library is intended to simplify the integration process with Tropipay's services, but it is essential to consult the official documentation to ensure that you are using the API correctly and taking into account any recent changes or updates made by Tropipay.
 
@@ -37,11 +35,11 @@ The library is intended to simplify the integration process with Tropipay's serv
 
 You can use npm or yarn to install this package:
 
-```npm install @yosle/tropipayjs``` 
+`npm install @yosle/tropipayjs`
 
 or
 
-```yarn add @yosle/tropipayjs```
+`yarn add @yosle/tropipayjs`
 
 ## Setting up your app credentials
 
@@ -52,18 +50,18 @@ In order to use the Tropipay API you'll need a client ID and a client secret. Si
 
 ## Usage
 
-The Tropipay instance, allows you to access all the method available in the API. This Object is meant to be used *only in server side*. Do not use the Tropipay object on the client side (browser). This would expose your app credentials (the client secret of your account). You can create an endpoint at your back-end using express and consume it in your front-end, or use SSR if you're using NextJS.
+The Tropipay instance, allows you to access all the method available in the API. This Object is meant to be used _only in server side_. Do not use the Tropipay object on the client side (browser). This would expose your app credentials (the client secret of your account). You can create an endpoint at your back-end using express and consume it in your front-end, or use SSR if you're using NextJS.
 
-### CommonJS 
+### CommonJS
 
 ```javascript
-const { Tropipay } = require('@yosle/tropipayjs')
+const { Tropipay } = require("@yosle/tropipayjs");
 ```
 
-### ES6 
+### ES6
 
 ```javascript
-import { Tropipay } from '@yosle/tropipayjs'
+import { Tropipay } from "@yosle/tropipayjs";
 ```
 
 ### Initialize the Tropipay class
@@ -72,7 +70,7 @@ You can instantiate the Tropipay class passing the client Id ,client secret and
 
 ```javascript
 // test environment server tropipay-dev.herokuapp.com
-const config = {    
+const config = {
     clientId: process.env.TROPIPAY_CLIENT_ID,
     clientSecret: process.env.TROPIPAY_CLIENT_SECRET
     serverMode: 'Development' // it will be used as default if omited
@@ -84,48 +82,48 @@ To use your live credentials (real account) you must explicity set serverMode to
 
 ```javascript
 //real account credentials
-const config = {    
-    clientId: process.env.TROPIPAY_CLIENT_ID,
-    clientSecret: process.env.TROPIPAY_CLIENT_SECRET,
-    serverMode: 'Production' //live account
-}
-const tpp = new Tropipay(config)
+const config = {
+  clientId: process.env.TROPIPAY_CLIENT_ID,
+  clientSecret: process.env.TROPIPAY_CLIENT_SECRET,
+  serverMode: "Production", //live account
+};
+const tpp = new Tropipay(config);
 ```
 
 ### Generating a Payment Link
 
 ```javascript
 /*
-* Example Payload
-*/
+ * Example Payload
+ */
 const payload = {
-        reference: "my-paylink-1",
-        concept: "Bicycle",
-        favorite: "true",
-        amount: 3000,
-        currency: "EUR",
-        description: "Two wheels",
-        singleUse: "true",
-        reasonId: 4,
-        expirationDays: 1,
-        lang: "es",
-        urlSuccess: "https://webhook.site/680826a5-199e-4455-babc-f47b7f26ee7e",
-        urlFailed: "https://webhook.site/680826a5-199e-4455-babc-f47b7f26ee7e",
-        urlNotification: "https://webhook.site/680826a5-199e-4455-babc-f47b7f26ee7e",
-        serviceDate: "2021-08-20",
-        client: {
-            name: "John",
-            lastName: "McClane",
-            address: "Ave. Guadí 232, Barcelona, Barcelona",
-            phone: "+34645553333",
-            email: "client@email.com",
-            countryId: 1,
-            termsAndConditions: "true"
-        },
-        directPayment: "true"
-    }
+  reference: "my-paylink-1",
+  concept: "Bicycle",
+  favorite: "true",
+  amount: 3000,
+  currency: "EUR",
+  description: "Two wheels",
+  singleUse: "true",
+  reasonId: 4,
+  expirationDays: 1,
+  lang: "es",
+  urlSuccess: "https://webhook.site/680826a5-199e-4455-babc-f47b7f26ee7e",
+  urlFailed: "https://webhook.site/680826a5-199e-4455-babc-f47b7f26ee7e",
+  urlNotification: "https://webhook.site/680826a5-199e-4455-babc-f47b7f26ee7e",
+  serviceDate: "2021-08-20",
+  client: {
+    name: "John",
+    lastName: "McClane",
+    address: "Ave. Guadí 232, Barcelona, Barcelona",
+    phone: "+34645553333",
+    email: "client@email.com",
+    countryId: 1,
+    termsAndConditions: "true",
+  },
+  directPayment: "true",
+};
 // Use inside an async function
-const paylink = await tpp.createPaymentCard(payload);
+const paylink = await tpp.paymentCards.create(payload);
 console.log(paylink.shortUrl);
 ```
 
@@ -140,15 +138,11 @@ If you have a suggestion that would make this better, please fork the repo and c
 3. Commit your Changes (`git commit -m 'Add some AmazingFeature`)
 4. Push to the Branch (`git push origin feature/AmazingFeature`)
 5. Open a Pull Request
-   
-Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. 
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 
 You can also make a small [donation to the author](https://tppay.me/l94qaa3h) of the library.
 
 # License
 
 Distributed under the MIT License. See `LICENSE.txt` for more information.
-
-
-
-

package/api/TropipayAPI.d.ts

@@ -8,6 +8,8 @@ import { Axios } from "axios";
 import { TropipayConfig, AccountBalance, Country, PaymentLink, mediationPaymentCardConfig, LoginResponse, AccountDeposits } from "../interfaces";
 type ServerMode = "Development" | "Production";
 import { TropipayHooks } from "../hooks/TropipayHooks";
+import { PaymentCard } from "../paymentcard/PaymentCard";
+import { DepositAccounts } from "../depositAccount/depositAccounts";
 export declare class Tropipay {
     readonly clientId: string;
     readonly clientSecret: string;
@@ -16,6 +18,8 @@ export declare class Tropipay {
     static refreshToken: string | undefined;
     serverMode: ServerMode;
     hooks: TropipayHooks;
+    paymentCards: PaymentCard;
+    depositAccounts: DepositAccounts;
     constructor(config: TropipayConfig);
     login(): Promise<LoginResponse>;
     /**

package/depositAccount/depositAccounts.d.ts

@@ -0,0 +1,36 @@
+import { Tropipay } from "../api/TropipayAPI";
+import { DepositAccountConfig } from "../interfaces/depositaccounts";
+export declare class DepositAccounts {
+    private tropipay;
+    constructor(tropipayInstance: Tropipay);
+    /**
+     * List od all beneficiaries of this account
+     * @returns Array of DepositAccounts
+     */
+    list(): Promise<any>;
+    /**
+     * Adds a new beneficiary to the user account.
+     * @param payload
+     * @returns
+     */
+    create(depositAccountObj: DepositAccountConfig): Promise<any>;
+    /**
+     * This returns details of a specific
+     * Deposit Account (beneficiary) specified by its ID
+     * @param id
+     * @returns
+     */
+    get(id: string): Promise<any>;
+    /**
+     * Updates certain beneficiary data.
+     * @param depositAccountObj
+     * @returns
+     */
+    update(depositAccountObj: Partial<DepositAccountConfig>): Promise<any>;
+    /**
+     * (UNTESTED) Deletes the beneficiary indicated by id
+     * @param id
+     * @returns
+     */
+    delete(id: number): Promise<any>;
+}

package/index.d.ts

@@ -198,6 +198,87 @@ declare class TropipayHooks {
     events(): Promise<any>;
 }
 
+declare class PaymentCard {
+    private tropipay;
+    constructor(tropipayInstance: Tropipay);
+    /**
+     * 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
+     */
+    create(payload: PaymentLinkPayload): Promise<PaymentLink>;
+    /**
+     * Shows a list of stored paymentcards created by user.
+     * This list includes active and closed paylinks
+     * @returns Array of paymentlinks
+     */
+    list(): Promise<any>;
+    get(id: string): Promise<any>;
+}
+
+interface DepositAccountConfig {
+    searchValue?: string;
+    alias: string;
+    userRelationTypeId: number;
+    beneficiaryType: BeneficiaryType;
+    searchBy?: number;
+    accountNumber?: string;
+    swift?: string;
+    type?: number;
+    firstName?: string;
+    lastName?: string;
+    secondLastName?: string;
+    countryDestinationId?: number;
+    city?: string;
+    postalCode?: number;
+    address?: string;
+    documentNumber?: string;
+    phone?: string;
+    province?: string;
+    paymentType?: string;
+    documentTypeId?: number;
+    documentExpirationDate: string;
+}
+type INTERNAL = 1;
+type EXTERNAL = 2;
+type BeneficiaryType = INTERNAL | EXTERNAL;
+
+declare class DepositAccounts {
+    private tropipay;
+    constructor(tropipayInstance: Tropipay);
+    /**
+     * List od all beneficiaries of this account
+     * @returns Array of DepositAccounts
+     */
+    list(): Promise<any>;
+    /**
+     * Adds a new beneficiary to the user account.
+     * @param payload
+     * @returns
+     */
+    create(depositAccountObj: DepositAccountConfig): Promise<any>;
+    /**
+     * This returns details of a specific
+     * Deposit Account (beneficiary) specified by its ID
+     * @param id
+     * @returns
+     */
+    get(id: string): Promise<any>;
+    /**
+     * Updates certain beneficiary data.
+     * @param depositAccountObj
+     * @returns
+     */
+    update(depositAccountObj: Partial<DepositAccountConfig>): Promise<any>;
+    /**
+     * (UNTESTED) Deletes the beneficiary indicated by id
+     * @param id
+     * @returns
+     */
+    delete(id: number): Promise<any>;
+}
+
 /**
  * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
  *
@@ -215,6 +296,8 @@ declare class Tropipay {
     static refreshToken: string | undefined;
     serverMode: ServerMode;
     hooks: TropipayHooks;
+    paymentCards: PaymentCard;
+    depositAccounts: DepositAccounts;
     constructor(config: TropipayConfig);
     login(): Promise<LoginResponse>;
     /**
@@ -300,25 +383,6 @@ declare class ServerSideUtils {
     } | Tropipay, originalCurrencyAmount: string, bankOrderCode: string, signature: string): boolean;
 }
 
-declare class PaymentCard {
-    private tropipay;
-    constructor(tropipayInstance: Tropipay);
-    /**
-     * 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
-     */
-    create(payload: PaymentLinkPayload): Promise<PaymentLink>;
-    /**
-     * Shows a list of stored paymentcards created by user.
-     * This list includes active and closed paylinks
-     * @returns Array of paymentlinks
-     */
-    list(): Promise<any>;
-    get(id: string): Promise<any>;
-}
-
 declare const SERVER_MODE: ServerMode$1;
 
-export { AccountBalance, AccountDeposits, ClientSideUtils, Country, Deposit, HookEventType, HookTargetType, LoginError, LoginResponse, PaymentCard, PaymentLink, PaymentLinkPayload, SERVER_MODE, ServerMode$1 as ServerMode, ServerSideUtils, Tropipay, TropipayConfig, TropipayCredentials, TropipayHooks, UserHook, UserHookSubscribed, mediationPaymentCardConfig };
+export { AccountBalance, AccountDeposits, ClientSideUtils, Country, Deposit, DepositAccounts, HookEventType, HookTargetType, LoginError, LoginResponse, PaymentCard, PaymentLink, PaymentLinkPayload, SERVER_MODE, ServerMode$1 as ServerMode, ServerSideUtils, Tropipay, TropipayConfig, TropipayCredentials, TropipayHooks, UserHook, UserHookSubscribed, mediationPaymentCardConfig };

package/index.js

@@ -158,6 +158,200 @@ class TropipayHooks {
     }
 }
 
+class PaymentCard {
+    tropipay;
+    constructor(tropipayInstance) {
+        this.tropipay = tropipayInstance;
+    }
+    /**
+     * 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 create(payload) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const paylink = await this.tropipay.request.post("/api/v2/paymentcards", payload, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return paylink.data;
+        }
+        catch (error) {
+            throw new Error(`TropipayJS - Error creating the Payment Card.`);
+        }
+    }
+    /**
+     * Shows a list of stored paymentcards created by user.
+     * This list includes active and closed paylinks
+     * @returns Array of paymentlinks
+     */
+    async list() {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const paymentcards = await this.tropipay.request.get(`/api/v2/paymentcards`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return paymentcards.data;
+        }
+        catch (error) {
+            throw new Error(`Could not retrieve PaymenCards list`);
+        }
+    }
+    async get(id) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const paymentcard = await this.tropipay.request.get(`/api/v2/paymentcards/${id}`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return paymentcard.data;
+        }
+        catch (error) {
+            throw new Error(`Could not retrieve PaymenCards`);
+        }
+    }
+}
+
+class DepositAccounts {
+    tropipay;
+    constructor(tropipayInstance) {
+        this.tropipay = tropipayInstance;
+    }
+    /**
+     * List od all beneficiaries of this account
+     * @returns Array of DepositAccounts
+     */
+    async list() {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const deposit = await this.tropipay.request.get(`/api/v2/deposit_accounts`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return deposit.data;
+        }
+        catch (error) {
+            throw new Error(`Could not retrieve PaymenCards list`);
+        }
+    }
+    /**
+     * Adds a new beneficiary to the user account.
+     * @param payload
+     * @returns
+     */
+    async create(depositAccountObj) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const deposit = await this.tropipay.request.post("/api/v2/deposit_accounts", depositAccountObj, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return deposit.data;
+        }
+        catch (error) {
+            throw new Error(`TropipayJS - Error creating the Deposit Accounts.`);
+        }
+    }
+    /**
+     * This returns details of a specific
+     * Deposit Account (beneficiary) specified by its ID
+     * @param id
+     * @returns
+     */
+    async get(id) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const deposit = await this.tropipay.request.get(`/api/v2/deposit_accounts/${id}`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return deposit.data;
+        }
+        catch (error) {
+            throw new Error(`Could not retrieve deposit account`);
+        }
+    }
+    /**
+     * Updates certain beneficiary data.
+     * @param depositAccountObj
+     * @returns
+     */
+    async update(depositAccountObj) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const deposit = await this.tropipay.request.put(`/api/v2/deposit_accounts/`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return deposit.data;
+        }
+        catch (error) {
+            throw new Error(`Could not retrieve deposit account`);
+        }
+    }
+    /**
+     * (UNTESTED) Deletes the beneficiary indicated by id
+     * @param id
+     * @returns
+     */
+    async delete(id) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const deposit = await this.tropipay.request.delete(`/api/v2/deposit_accounts/${id}`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return deposit.data;
+        }
+        catch (error) {
+            throw new Error(`Could not retrieve deposit account`);
+        }
+    }
+}
+
 /**
  * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
  *
@@ -172,6 +366,8 @@ class Tropipay {
     static refreshToken;
     serverMode;
     hooks;
+    paymentCards;
+    depositAccounts;
     constructor(config) {
         this.clientId = config.clientId;
         this.clientSecret = config.clientSecret;
@@ -187,6 +383,8 @@ class Tropipay {
             },
         });
         this.hooks = new TropipayHooks(this);
+        this.paymentCards = new PaymentCard(this);
+        this.depositAccounts = new DepositAccounts(this);
     }
     async login() {
         try {
@@ -436,78 +634,6 @@ class ServerSideUtils {
     }
 }
 
-class PaymentCard {
-    tropipay;
-    constructor(tropipayInstance) {
-        this.tropipay = tropipayInstance;
-    }
-    /**
-     * 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 create(payload) {
-        if (!Tropipay.accessToken) {
-            await this.tropipay.login();
-        }
-        try {
-            const paylink = await this.tropipay.request.post("/api/v2/paymentcards", payload, {
-                headers: {
-                    "Content-Type": "application/json",
-                    Authorization: `Bearer ${Tropipay.accessToken}`,
-                    Accept: "application/json",
-                },
-            });
-            return paylink.data;
-        }
-        catch (error) {
-            throw new Error(`TropipayJS - Error creating the Payment Card.`);
-        }
-    }
-    /**
-     * Shows a list of stored paymentcards created by user.
-     * This list includes active and closed paylinks
-     * @returns Array of paymentlinks
-     */
-    async list() {
-        if (!Tropipay.accessToken) {
-            await this.tropipay.login();
-        }
-        try {
-            const paymentcards = await this.tropipay.request.get(`/api/v2/paymentcards`, {
-                headers: {
-                    "Content-Type": "application/json",
-                    Authorization: `Bearer ${Tropipay.accessToken}`,
-                    Accept: "application/json",
-                },
-            });
-            return paymentcards.data;
-        }
-        catch (error) {
-            throw new Error(`Could not retrieve PaymenCards list`);
-        }
-    }
-    async get(id) {
-        if (!Tropipay.accessToken) {
-            await this.tropipay.login();
-        }
-        try {
-            const paymentcard = await this.tropipay.request.get(`/api/v2/paymentcards/${id}`, {
-                headers: {
-                    "Content-Type": "application/json",
-                    Authorization: `Bearer ${Tropipay.accessToken}`,
-                    Accept: "application/json",
-                },
-            });
-            return paymentcard.data;
-        }
-        catch (error) {
-            throw new Error(`Could not retrieve PaymenCards`);
-        }
-    }
-}
-
 const SERVER_MODE = "Development"; // Move the constant here
 
 /**
@@ -526,6 +652,7 @@ if (typeof window !== "undefined") {
 }
 
 exports.ClientSideUtils = ClientSideUtils;
+exports.DepositAccounts = DepositAccounts;
 exports.PaymentCard = PaymentCard;
 exports.SERVER_MODE = SERVER_MODE;
 exports.ServerSideUtils = ServerSideUtils;

package/interfaces/depositaccounts/index.d.ts

@@ -0,0 +1,27 @@
+export interface DepositAccountConfig {
+    searchValue?: string;
+    alias: string;
+    userRelationTypeId: number;
+    beneficiaryType: BeneficiaryType;
+    searchBy?: number;
+    accountNumber?: string;
+    swift?: string;
+    type?: number;
+    firstName?: string;
+    lastName?: string;
+    secondLastName?: string;
+    countryDestinationId?: number;
+    city?: string;
+    postalCode?: number;
+    address?: string;
+    documentNumber?: string;
+    phone?: string;
+    province?: string;
+    paymentType?: string;
+    documentTypeId?: number;
+    documentExpirationDate: string;
+}
+type INTERNAL = 1;
+type EXTERNAL = 2;
+export type BeneficiaryType = INTERNAL | EXTERNAL;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yosle/tropipayjs",
-  "version": "0.1.13",
+  "version": "0.1.15",
   "description": "Javascript / Typescript SDK for the Tropipay API",
   "main": "index.js",
   "scripts": {

package/src/api/TropipayAPI.ts

@@ -18,6 +18,8 @@ import {
 } from "../interfaces";
 type ServerMode = "Development" | "Production";
 import { TropipayHooks } from "../hooks/TropipayHooks";
+import { PaymentCard } from "../paymentcard/PaymentCard";
+import { DepositAccounts } from "../depositAccount/depositAccounts";
 export class Tropipay {
   readonly clientId: string;
   readonly clientSecret: string;
@@ -26,6 +28,8 @@ export class Tropipay {
   public static refreshToken: string | undefined;
   public serverMode: ServerMode;
   public hooks: TropipayHooks;
+  public paymentCards: PaymentCard;
+  public depositAccounts: DepositAccounts;
 
   constructor(config: TropipayConfig) {
     this.clientId = config.clientId;
@@ -43,6 +47,8 @@ export class Tropipay {
       },
     });
     this.hooks = new TropipayHooks(this);
+    this.paymentCards = new PaymentCard(this);
+    this.depositAccounts = new DepositAccounts(this);
   }
 
   public async login() {

package/src/depositAccount/depositAccounts.ts

@@ -0,0 +1,138 @@
+import { Tropipay } from "../api/TropipayAPI";
+import { DepositAccountConfig } from "../interfaces/depositaccounts";
+
+export class DepositAccounts {
+  private tropipay: Tropipay;
+  constructor(tropipayInstance: Tropipay) {
+    this.tropipay = tropipayInstance;
+  }
+
+  /**
+   * List od all beneficiaries of this account
+   * @returns Array of DepositAccounts
+   */
+  public async list() {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const deposit = await this.tropipay.request.get(
+        `/api/v2/deposit_accounts`,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return deposit.data;
+    } catch (error) {
+      throw new Error(`Could not retrieve PaymenCards list`);
+    }
+  }
+  /**
+   * Adds a new beneficiary to the user account.
+   * @param payload
+   * @returns
+   */
+  public async create(depositAccountObj: DepositAccountConfig) {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const deposit = await this.tropipay.request.post(
+        "/api/v2/deposit_accounts",
+        depositAccountObj,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return deposit.data;
+    } catch (error) {
+      throw new Error(`TropipayJS - Error creating the Deposit Accounts.`);
+    }
+  }
+  /**
+   * This returns details of a specific
+   * Deposit Account (beneficiary) specified by its ID
+   * @param id
+   * @returns
+   */
+  public async get(id: string) {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const deposit = await this.tropipay.request.get(
+        `/api/v2/deposit_accounts/${id}`,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return deposit.data;
+    } catch (error) {
+      throw new Error(`Could not retrieve deposit account`);
+    }
+  }
+
+  /**
+   * Updates certain beneficiary data.
+   * @param depositAccountObj
+   * @returns
+   */
+  public async update(depositAccountObj: Partial<DepositAccountConfig>) {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const deposit = await this.tropipay.request.put(
+        `/api/v2/deposit_accounts/`,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return deposit.data;
+    } catch (error) {
+      throw new Error(`Could not retrieve deposit account`);
+    }
+  }
+
+  /**
+   * (UNTESTED) Deletes the beneficiary indicated by id
+   * @param id
+   * @returns
+   */
+  public async delete(id: number) {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const deposit = await this.tropipay.request.delete(
+        `/api/v2/deposit_accounts/${id}`,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return deposit.data;
+    } catch (error) {
+      throw new Error(`Could not retrieve deposit account`);
+    }
+  }
+}

package/src/index.ts

@@ -10,6 +10,8 @@
  * @license MIT
  */
 
+import { DepositAccounts } from "./depositAccount/depositAccounts";
+
 if (typeof window !== "undefined") {
   console.warn(
     "DANGER This library should not be used client side, your credentials could be exposed"
@@ -21,6 +23,7 @@ export { ClientSideUtils } from "./api/TropipayAPI";
 export { ServerSideUtils } from "./utils/TropipayUtils";
 export { TropipayHooks } from "./hooks/TropipayHooks";
 export { PaymentCard } from "./paymentcard/PaymentCard";
+export { DepositAccounts } from "./depositAccount/depositAccounts";
 export * from "./interfaces/index";
 export { SERVER_MODE } from "./config/TropipayConfig";
 export * from "./constants/TropipayConstants";

package/src/interfaces/depositaccounts/index.ts

@@ -0,0 +1,27 @@
+export interface DepositAccountConfig {
+  searchValue?: string;
+  alias: string;
+  userRelationTypeId: number;
+  beneficiaryType: BeneficiaryType;
+  searchBy?: number;
+  accountNumber?: string;
+  swift?: string;
+  type?: number;
+  firstName?: string;
+  lastName?: string;
+  secondLastName?: string;
+  countryDestinationId?: number;
+  city?: string;
+  postalCode?: number;
+  address?: string;
+  documentNumber?: string;
+  phone?: string;
+  province?: string;
+  paymentType?: string;
+  documentTypeId?: number;
+  documentExpirationDate: string;
+}
+type INTERNAL = 1;
+type EXTERNAL = 2;
+
+export type BeneficiaryType = INTERNAL | EXTERNAL;

package/src/paymentcard/PaymentCard.ts

@@ -3,7 +3,6 @@ import { PaymentLink } from "../interfaces";
 import { PaymentLinkPayload } from "../interfaces";
 export class PaymentCard {
   private tropipay: Tropipay;
-
   constructor(tropipayInstance: Tropipay) {
     this.tropipay = tropipayInstance;
   }