[feature] Extended Web Card PayIn endpoint integration (#437)

* added missing stuff

* added typings for extended card web payin details

* small adjustments

* commented test

* removed integration for deprected endpoint

* updated test

* updated docs

---------

Co-authored-by: Iulian Masar <[email protected]>

Author: iulian03

lib/apiMethods.js

@@ -30,6 +30,7 @@ module.exports = {
 
     // pay ins URLs
     "payins_card-web_create": ["/${apiVersion}/${clientId}/payins/card/web/", "POST"],
+    "payins_card-web_get_details": ["/${apiVersion}/${clientId}/payins/card/web/${id}/extended", "GET"],
     "payins_card-direct_create": ["/${apiVersion}/${clientId}/payins/card/direct/", "POST"],
     "payins_preauthorized-direct_create": ["/${apiVersion}/${clientId}/payins/preauthorized/direct/", "POST"],
     "payins_bankwire-direct_create": ["/${apiVersion}/${clientId}/payins/bankwire/direct/", "POST"],

lib/models/User.js

@@ -23,12 +23,16 @@ var User = EntityBase.extend({
          */
         TermsAndConditionsAccepted: null,
 
+        TermsAndConditionsAcceptedDate: null,
+
         /**
          * Category of the user. May take one of the following values:
          * PAYER - Users who only use MANGOPAY to give money to other users
          * OWNER - Users who use MANGOPAY to receive funds. Please note that a user needs to be KYC validated to perform payouts
          */
-        UserCategory: null
+        UserCategory: null,
+
+        UserStatus: null
     },
 
     /**

lib/services/PayIns.js

@@ -281,6 +281,16 @@ var PayIns = Service.extend({
         return this._api.method('add_tracking_info', callback, options);
     },
 
+    getCardWebPayInExtendedDetails: function(payInId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                id: payInId
+            }
+        });
+
+        return this._api.method('payins_card-web_get_details', callback, options);
+    },
+
     getPaymentKey: function(payIn) {
         if (payIn.PaymentType) {
             return payIn.PaymentType.toLowerCase().replaceAll('_', '');

test/services/PayIns.js

@@ -54,6 +54,23 @@ describe('PayIns', function () {
                 expect(getPayIn.ReturnURL).not.to.be.undefined;
             });
         });
+
+        describe.skip('Get extended details', function () {
+            console.warn('Cannot be tested because a Succeeded Card Web PayIn cannot be generated from the tests');
+            var extendedDetails;
+            before(function (done) {
+                api.PayIns.getCardWebPayInExtendedDetails(payIn.Id, function (data, response) {
+                    extendedDetails = data;
+                    done();
+                });
+            });
+
+            it('should get the PayIn', function () {
+                expect(extendedDetails.Id).not.to.be.undefined;
+                expect(extendedDetails.PaymentType).to.equal('CARD');
+                expect(extendedDetails.ExecutionType).to.equal('WEB');
+            });
+        });
     });
 
     describe('Card Direct', function () {

typings/models/payIn.d.ts

@@ -190,6 +190,48 @@ export namespace payIn {
         BankName: string;
     }
 
+    interface CardWebExtendedPayInData {
+        /**
+         * The unique identifier of the object.
+         */
+        Id: string;
+
+        /**
+         * The type of payin
+         */
+        PaymentType: PayInPaymentType;
+
+        /**
+         * The type of execution for the payin
+         */
+        ExecutionType: PayInExecutionType;
+
+        /**
+         * Time in millis when the page consult will expire.
+         */
+        ExpirationDate: Timestamp;
+
+        /**
+         * A partially obfuscated version of the credit card number
+         */
+        Alias: string;
+
+        /**
+         * The type of card
+         */
+        CardType: card.CardType;
+
+        /**
+         * The Country of the Card
+         */
+        Country: CountryISO;
+
+        /**
+         * A unique representation of a 16-digits card number
+         */
+        Fingerprint: string;
+    }
+
     interface CreateCardWebPayIn {
         ExecutionType: "WEB";
 

typings/models/user.d.ts

@@ -107,12 +107,19 @@ export namespace user {
          */
         TermsAndConditionsAccepted?: boolean;
 
+        /**
+         * The date when the user has accepted the MANGOPAY Terms and Conditions.
+         */
+        TermsAndConditionsAcceptedDate?: number;
+
         /**
          * Category of the user. May take one of the following values:
          * PAYER - Users who only use MANGOPAY to give money to other users
          * OWNER - Users who use MANGOPAY to receive funds. Please note that a user needs to be KYC validated to perform payouts
          */
         UserCategory?: UserCategory;
+
+        UserStatus?: string;
     }
 
     interface UserLegalData extends UserData {

typings/services/PayIns.d.ts

@@ -130,4 +130,11 @@ export class PayIns {
     addPayPalTrackingInformation: TwoArgsMethodOverload<string,
         payIn.PayPalWebTrackingData,
         payIn.PayPalWebPayInData>;
+
+    /**
+     * View card details for a Web Card PayIn
+     * @param payInId
+     * @param options
+     */
+    getCardWebPayInExtendedDetails: MethodOverload<string, payIn.CardWebExtendedPayInData>;
 }