mangopay4-nodejs-sdk 1.64.0

package/lib/models/PayInPaymentDetailsCardWeb.js

@@ -0,0 +1,28 @@
+var _ = require('underscore');
+var PayInPaymentDetailsCard = require('./PayInPaymentDetailsCard');
+
+var PayInPaymentDetailsCardWeb = PayInPaymentDetailsCard.extend({
+    defaults: _.extend({}, PayInPaymentDetailsCard.prototype.defaults, {
+        /**
+         *  CardType { CB_VISA_MASTERCARD, AMEX }
+         */
+        CardType: null,
+
+        /*
+         * Shipping
+         */
+        Shipping: null,
+
+        /**
+         * The BIC identifier of the end-user’s bank
+         */
+        Bic: null,
+
+        /**
+         * Name of the end-user’s bank
+         */
+        BankName: null,
+    })
+});
+
+module.exports = PayInPaymentDetailsCardWeb;

package/lib/models/PayInPaymentDetailsDirectDebitDirect.js

@@ -0,0 +1,22 @@
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsDirectDebit = PayInPaymentDetails.extend({
+    defaults: {
+        /**
+         * Mandate identifier.
+         */
+        MandateId: null,
+
+        /**
+         * An optional value to be specified on the user's bank statement
+         */
+        StatementDescriptor: null,
+
+        /**
+         * Date of charging
+         */
+        ChargeDate: null
+    }
+});
+
+module.exports = PayInPaymentDetailsDirectDebit;

package/lib/models/PayInPaymentDetailsDirectDebitWeb.js

@@ -0,0 +1,13 @@
+var _ = require('underscore');
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsDirectDebit = PayInPaymentDetails.extend({
+    defaults: {
+        /**
+         *  Direct debit type {SOFORT, ELV, GIROPAY}
+         */
+        DirectDebitType: null
+    }
+});
+
+module.exports = PayInPaymentDetailsDirectDebit;

package/lib/models/PayInPaymentDetailsGiropay.js

@@ -0,0 +1,15 @@
+var _ = require('underscore');
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsGiropay = PayInPaymentDetails.extend({
+    defaults: {
+
+        /**
+         * Custom description to show on the user's bank statement.
+         * It can be up to 10 char alpha-numeric and space.
+         */
+        StatementDescriptor: null
+    }
+});
+
+module.exports = PayInPaymentDetailsGiropay;

package/lib/models/PayInPaymentDetailsGooglePay.js

@@ -0,0 +1,35 @@
+var _ = require('underscore');
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsGooglePay = PayInPaymentDetails.extend({
+    defaults: {
+        /**
+         * Payment information returned by Google Pay payment
+         */
+        PaymentData: null,
+
+        /**
+         * Custom description to show on the user's bank statement.
+         * It can be up to 10 char alpha-numeric and space.
+         */
+        StatementDescriptor: null,
+
+        /**
+         * Billing details
+         */
+        Billing: null,
+
+
+        /// V2 ///
+
+        ReturnURL: null,
+
+        Shipping: null,
+
+        BrowserInfo: null,
+
+        IpAddress: null
+    }
+});
+
+module.exports = PayInPaymentDetailsGooglePay;

package/lib/models/PayInPaymentDetailsIdeal.js

@@ -0,0 +1,25 @@
+var _ = require('underscore');
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsIdeal = PayInPaymentDetails.extend({
+    defaults: {
+
+        /**
+         * The BIC identifier of the end-user’s bank
+         */
+        Bic: null,
+
+        /**
+         * Name of the end-user’s bank
+         */
+        BankName: null,
+
+        /**
+         * Custom description to show on the user's bank statement.
+         * It can be up to 10 char alpha-numeric and space.
+         */
+        StatementDescriptor: null
+    }
+});
+
+module.exports = PayInPaymentDetailsIdeal;

package/lib/models/PayInPaymentDetailsKlarna.js

@@ -0,0 +1,36 @@
+var _ = require('underscore');
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsKlarna = PayInPaymentDetails.extend({
+    defaults: {
+        LineItems: null,
+
+        Shipping: null,
+
+        Billing: null,
+
+        PaymentMethod: null,
+
+        Country: null,
+
+        AdditionalData: null,
+
+        Email: null,
+
+        Reference: null,
+
+        /**
+         * Custom description to show on the user's bank statement.
+         * It can be up to 10 char alpha-numeric and space.
+         */
+        StatementDescriptor: null,
+
+        /**
+         * The mobile phone number of the user initiating the pay-in
+         * Country code followed by hash symbol (#) followed by the rest of the number. Only digits and hash allowed
+         */
+        Phone: null
+    }
+});
+
+module.exports = PayInPaymentDetailsKlarna;

package/lib/models/PayInPaymentDetailsMbway.js

@@ -0,0 +1,20 @@
+var _ = require('underscore');
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsMbway = PayInPaymentDetails.extend({
+    defaults: {
+        /**
+         * Custom description to show on the user's bank statement.
+         * It can be up to 10 char alpha-numeric and space.
+         */
+        StatementDescriptor: null,
+
+        /**
+         * The mobile phone number of the user initiating the pay-in
+         * Country code followed by hash symbol (#) followed by the rest of the number. Only digits and hash allowed
+         */
+        Phone: null
+    }
+});
+
+module.exports = PayInPaymentDetailsMbway;

package/lib/models/PayInPaymentDetailsMultibanco.js

@@ -0,0 +1,14 @@
+var _ = require('underscore');
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsMultibanco = PayInPaymentDetails.extend({
+    defaults: {
+        /**
+         * Custom description to show on the user's bank statement.
+         * It can be up to 10 char alpha-numeric and space.
+         */
+        StatementDescriptor: null
+    }
+});
+
+module.exports = PayInPaymentDetailsMultibanco;

package/lib/models/PayInPaymentDetailsPayByBank.js

@@ -0,0 +1,71 @@
+var _ = require('underscore');
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsPayByBank = PayInPaymentDetails.extend({
+    defaults: {
+
+        /**
+         * Custom description to appear on the user’s bank statement along with the platform name
+         */
+        StatementDescriptor: null,
+
+        /**
+         * The end-user residency country
+         */
+        Country: null,
+
+        /**
+         * The BIC identifier of the end-user’s bank
+         */
+        BIC: null,
+
+        /**
+         * The IBAN identifier of the end-user’s bank
+         */
+        IBAN: null,
+
+        /**
+         * This is the platform environment in which the application is running.Accepted values are:
+         *
+         * - WEB: For web browser usage(default setting)
+         *
+         * - APP: For mobile application usage
+         *
+         * If PaymentFlow is set to APP,the user is redirected to the platform's app after payment
+         */
+        PaymentFlow: null,
+
+        /**
+         * Name of the end-user’s bank
+         */
+        BankName: null,
+
+        /**
+         * The language in which the Pay by Bank payment page isto be displayed - Alpha-2 format (default US)
+         */
+        Culture: null,
+
+        /**
+         * This is the payment scheme the end user selects for processing the transaction,which varies by market
+         * (see details below). Default values are always instant schemes.
+         *
+         * Please note that some banks may charge additional fees for instant payment schemes
+         *
+         * Please note that the scheme is mandatory for the Danish market (”Country” : “DK”)
+         */
+        Scheme: null,
+
+        /**
+         * This is a temporary status indicating that the payment initiation was successful,
+         * but the funds have not yet been received in Mangopay's bank account
+         *
+         * This parameter is only relevant once the transaction has been processed by the end user.
+         * It is not returned when the payment is initiated or successfully completed
+         *
+         * Possible value: PENDING_SUCCEEDED
+         */
+        ProcessingStatus: null
+    }
+});
+
+module.exports = PayInPaymentDetailsPayByBank;

package/lib/models/PayInPaymentDetailsPayPal.js

@@ -0,0 +1,63 @@
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsPayPal = PayInPaymentDetails.extend({
+    defaults: {
+        /**
+         * Address used instead of the user's PayPal account address.
+         */
+        ShippingAddress: null,
+
+        /**
+         * Email address of the buyer's account.
+         */
+        PaypalBuyerAccountEmail: null,
+
+
+        /// V2 ///
+
+        /**
+         * The URL where users are automatically redirected after the payment is validated
+         */
+        ReturnURL: null,
+
+        /**
+         * The URL to which the user is redirected to complete the payment
+         */
+        RedirectUrl: null,
+
+        /**
+         * Custom description of the payment shown to the consumer when making payments and on the bank statement
+         */
+        StatementDescriptor: null,
+
+        /**
+         * User’s shipping address When not provided, the default address is the one register one the buyer PayPal account
+         */
+        Shipping: null,
+
+        /**
+         * Information about the items bought by the customer
+         */
+        LineItems: null,
+
+        ShippingPreference: null,
+
+        PaypalPayerID: null,
+
+        BuyerCountry: null,
+
+        BuyerFirstname: null,
+
+        BuyerLastname: null,
+
+        BuyerPhone: null,
+
+        PaypalOrderID: null,
+
+        CancelURL: null,
+
+        Trackings: null
+    }
+});
+
+module.exports = PayInPaymentDetailsPayPal;

package/lib/models/PayInPaymentDetailsPayconiq.js

@@ -0,0 +1,23 @@
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+var Money = require('./Money');
+
+var PayInPaymentDetailsPayconiq = PayInPaymentDetails.extend({
+    defaults: {
+        Country: null,
+        AuthorId: null,
+        DebitedFunds: null,
+        Fees: null,
+        DeepLinkURL: null,
+        StatementDescriptor: null,
+        QRCodeURL: null
+    },
+
+    getSubObjects: function() {
+        return {
+            'DebitedFunds': Money,
+            'Fees': Money
+        };
+    },
+});
+
+module.exports = PayInPaymentDetailsPayconiq;

package/lib/models/PayInPaymentDetailsPreAuthorized.js

@@ -0,0 +1,10 @@
+var _ = require('underscore');
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsPreAuthorized = PayInPaymentDetails.extend({
+    defaults: {
+        PreauthorizationId: null
+    }
+});
+
+module.exports = PayInPaymentDetailsPreAuthorized;

package/lib/models/PayInPaymentDetailsSatispay.js

@@ -0,0 +1,19 @@
+var _ = require('underscore');
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsSatispay = PayInPaymentDetails.extend({
+    defaults: {
+        /**
+         * Custom description to show on the user's bank statement.
+         * It can be up to 10 char alpha-numeric and space.
+         */
+        StatementDescriptor: null,
+
+        /**
+         * The end-user country of residence
+         */
+        Country: null
+    }
+});
+
+module.exports = PayInPaymentDetailsSatispay;

package/lib/models/PayInPaymentDetailsSwish.js

@@ -0,0 +1,35 @@
+var _ = require('underscore');
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsSwish = PayInPaymentDetails.extend({
+    defaults: {
+
+        /**
+         * Custom description to show on the user's bank statement.
+         * It can be up to 10 char alpha-numeric and space.
+         */
+        StatementDescriptor: null,
+
+        /**
+         * The mobile URL to which to redirect the user to complete the payment in an app-to-app flow.
+         */
+        DeepLinkURL: null,
+
+        /**
+         * The PNG file of the Swish QR code as a Base64-encoded string.
+         */
+        QRCodeURL: null,
+
+        /**
+         *  <p>Allowed values: WEB, APP</p>
+         *  <p>Default value: WEB</p>
+         *  <p>The platform environment of the post-payment flow. The PaymentFlow value combines with the ReturnURL to manage the redirection behavior after payment:</p>
+         *  <p>Set the value to APP to send the user to your platform’s mobile app</p>
+         *  <p>Set the value to WEB to send the user to a web browser</p>
+         *  <p>In both cases you need to provide the relevant ReturnURL, whether to your app or website.</p>
+         */
+        PaymentFlow: null
+    }
+});
+
+module.exports = PayInPaymentDetailsSwish;

package/lib/models/PayInPaymentDetailsTwint.js

@@ -0,0 +1,15 @@
+var _ = require('underscore');
+var PayInPaymentDetails = require('./PayInPaymentDetails');
+
+var PayInPaymentDetailsTwint = PayInPaymentDetails.extend({
+    defaults: {
+
+        /**
+         * Custom description to show on the user's bank statement.
+         * It can be up to 10 char alpha-numeric and space.
+         */
+        StatementDescriptor: null
+    }
+});
+
+module.exports = PayInPaymentDetailsTwint;

package/lib/models/PayInPaymentType.js

@@ -0,0 +1,21 @@
+module.exports = {
+    BankWire: 'BANK_WIRE',
+    Card: 'CARD',
+    DirectDebit: 'DIRECT_DEBIT',
+    Preauthorized: 'PREAUTHORIZED',
+    PayPal: 'PAYPAL',
+    ApplePay: 'APPLEPAY',
+    GooglePay: 'GOOGLE_PAY',
+    Payconiq: 'PAYCONIQ',
+    Mbway: 'MBWAY',
+    Bancontact: 'BCMC',
+    Bizum: 'BIZUM',
+    Multibanco: 'MULTIBANCO',
+    Satispay: 'SATISPAY',
+    Blik: 'BLIK',
+    Klarna: 'KLARNA',
+    Ideal: 'IDEAL',
+    Giropay: 'GIROPAY',
+    Swish: 'SWISH',
+    Twint: 'TWINT'
+};

package/lib/models/PayInRecurringRegistration.js

@@ -0,0 +1,64 @@
+var EntityBase = require('./EntityBase');
+var Money = require('./Money');
+var Billing = require('./Billing');
+var Shipping = require('./Shipping');
+var CurrentState = require('./RecurringPayInCurrentState')
+
+var PayInRecurringRegistration = EntityBase.extend({
+    defaults: {
+        /**
+         * Array with owners identities
+         */
+        AuthorId: null,
+        CardId: null,
+        CreditedWalletId: null,
+        CreditedUserId: null,
+        FirstTransactionDebitedFunds: null,
+        FirstTransactionFees: null,
+        Billing: null,
+        Shipping: null,
+        CreditedUserId: null,
+        EndDate: null,
+        Frequency: null,
+        FixedNextAmount: null,
+        FractionedPayment: null,
+        Migration: null,
+        NextTransactionDebitedFunds: null,
+        NextTransactionFees: null,
+        Status: null,
+        TotalAmount: null,
+        CycleNumber: null,
+        FreeCycles: null,
+        CurrentState: null,
+        PaymentType: null
+    },
+
+    /**
+     * Get mapping of model properties and corresponding object types
+     * @returns {Object}
+     */
+    getSubObjects: function() {
+        return {
+            'FirstTransactionDebitedFunds': Money,
+            'FirstTransactionFees': Money,
+            'Fees': Money,
+            'Billing': Billing,
+            'Shipping': Shipping,
+            'NextTransactionDebitedFunds': Money,
+            'NextTransactionFees': Money,
+            'CurrentState': CurrentState
+        }
+    },
+
+    /**
+     * Get array with read-only properties
+     * @return {Array} List of string properties
+     */
+    getReadOnlyProperties: function() {
+        var properties = EntityBase.prototype.getReadOnlyProperties();
+        properties.push('Status', 'TotalAmount', 'CycleNumber', 'CurrentState');
+        return properties;
+    }
+});
+
+module.exports = PayInRecurringRegistration;

package/lib/models/PayInTemplateURLOptions.js

@@ -0,0 +1,10 @@
+var EntityBase = require('./EntityBase');
+
+var PayInTemplateURLOptions = EntityBase.extend({
+    defaults: {
+        PAYLINE: null,
+        PAYLINEV2: null
+    }
+});
+
+module.exports = PayInTemplateURLOptions;

package/lib/models/PayOut.js

@@ -0,0 +1,24 @@
+var _ = require('underscore');
+var Transaction = require('./Transaction');
+
+var PayOut = Transaction.extend({
+    defaults: _.extend({}, Transaction.prototype.defaults, {
+        DebitedWalletId: null,
+        /**
+         * PaymentType (BANK_WIRE, MERCHANT_EXPENSE, AMAZON_GIFTCARD)
+         */
+        PaymentType: null,
+        /**
+         * One of PayOutPaymentDetails implementations, depending on PaymentType
+         */
+        MeanOfPaymentDetails: null
+    }),
+
+    getReadOnlyProperties: function() {
+        var properties = Transaction.prototype.getReadOnlyProperties();
+        properties.push('PaymentType');
+        return properties;
+    }
+});
+
+module.exports = PayOut;

package/lib/models/PayOutPaymentDetails.js

@@ -0,0 +1,7 @@
+var _ = require('underscore');
+var EntityBase = require('./EntityBase');
+
+var PayOutPaymentDetails = EntityBase.extend({
+});
+
+module.exports = PayOutPaymentDetails;

package/lib/models/PayOutPaymentDetailsBankWire.js

@@ -0,0 +1,32 @@
+var _ = require('underscore');
+var PayOutPaymentDetails = require('./PayOutPaymentDetails');
+
+var PayOutPaymentDetailsBankWire = PayOutPaymentDetails.extend({
+    defaults: {
+        BankAccountId: null,
+        /**
+         * A custom reference you wish to appear on the user’s bank statement
+         */
+        BankWireRef: null,
+
+        /**
+         * Payment reference provided for the payout.
+         */
+        PayoutPaymentRef: null,
+
+        /**
+         * The new parameter "PayoutModeRequested" can take the following values: "STANDARD", "INSTANT_PAYMENT", "INSTANT_PAYMENT_ONLY"
+         */
+        PayoutModeRequested: null,
+
+        ModeRequested: null,
+
+        ModeApplied: null,
+
+        Status: null,
+
+        FallbackReason: null
+    }
+});
+
+module.exports = PayOutPaymentDetailsBankWire;

package/lib/models/PayOutPaymentType.js

@@ -0,0 +1,3 @@
+module.exports = {
+    BankWire: 'BANK_WIRE'
+};

package/lib/models/PaymentData.js

@@ -0,0 +1,20 @@
+var EntityBase = require('./EntityBase');
+
+var PaymentData = EntityBase.extend({
+    defaults: {
+        /**
+         * ID of the Apple payment transaction
+         */
+        TransactionId: null,
+        /**
+         * Network card used for transaction
+         */
+        Network: null,
+        /**
+         * Data block containing payment information
+         */
+        TokenData: null,
+    }
+});
+
+module.exports = PaymentData;