mangopay4-nodejs-sdk 1.64.0

package/lib/services/PayOuts.js

@@ -0,0 +1,110 @@
+/**
+ * @module PayOuts
+ * @desc [MangoPay PayOuts API Reference](https://docs.mangopay.com/endpoints/v2.01/payouts)
+ */
+
+var Service = require('../service');
+
+var PayOut = require('../models/PayOut');
+var PayOutPaymentDetailsBankWire = require('../models/PayOutPaymentDetailsBankWire');
+var Refund = require('../models/Refund');
+
+var PayOuts = Service.extend({
+    /**
+     * Create new pay-out
+     * @param {Object}  payOut    PayOut object
+     * @param {Function} callback    Callback function
+     * @param {Object} options    Request options
+     * @return {Object}         Request promise
+     */
+    create: function(payOut, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: payOut,
+            dataClass: PayOut
+        });
+
+        var paymentKey = this.getPaymentKey(payOut);
+
+        return this._api.method('payouts_' + paymentKey + '_create', callback, options);
+    },
+
+    /**
+     * Get payout
+     * @param {number}  payOutId    PayOut identifiers
+     * @param {Function} callback    Callback function
+     * @param {Object} options    Request options
+     * @return {Object}         Request promise
+     */
+    get: function(payOutId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                id: payOutId
+            },
+            dataClass: PayOut
+        });
+
+        return this._api.method('payouts_get', callback, options);
+    },
+
+        /**
+     * Get payout
+     * @param {number}  payOutId    PayOut identifiers
+     * @param {Function} callback    Callback function
+     * @param {Object} options    Request options
+     * @return {Object}         Request promise
+     */
+    getBankwire: function(payOutId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                id: payOutId
+            },
+            dataClass: PayOut
+        });
+
+        return this._api.method('payouts_bankwire_get', callback, options);
+    },
+
+    /**
+     * Gets list of Refunds of a PayOut
+     * @param {number}      payOutId    PayOut identifier
+     * @param {function}    callback    Callback function
+     * @param {Object}      options     Request options
+     * @return {Object}                 Request promise
+     */
+    getRefunds: function(payOutId, callback, options) {
+        if (options && !options.hasOwnProperty('parameters'))
+            Object.assign(options, {parameters: {...options}});
+        options = this._api._getOptions(callback, options, {
+            path: {
+                id: payOutId
+            },
+            dataClass: Refund
+        });
+
+        return this._api.method("refunds_get_for_payout", callback, options);
+    },
+
+    getPaymentKey: function(payOut) {
+        if (!payOut.MeanOfPaymentDetails && !payOut.PaymentType) {
+            this._api.errorHandler('Create Payout needs MeanOfPaymentDetails or PaymentType');
+        }
+
+        // Payment Type can be BANK_WIRE, etc.
+        if (payOut.PaymentType) {
+            return payOut.PaymentType.toLowerCase().replace('_', '');
+        }
+
+        if (payOut.MeanOfPaymentDetails instanceof PayOutPaymentDetailsBankWire) return 'bankwire';
+    },
+
+    checkEligibility: function(payOut, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: payOut,
+            dataClass: PayOut
+        });
+
+        return this._api.method('payouts_check_eligibility', callback, options);
+    },
+});
+
+module.exports = PayOuts;

package/lib/services/Recipients.js

@@ -0,0 +1,117 @@
+var Service = require('../service');
+var Recipient = require('../models/Recipient');
+var RecipientSchema = require('../models/RecipientSchema');
+var PayoutMethods = require('../models/PayoutMethods');
+
+var Recipients = Service.extend({
+    /**
+     * Create a Recipient
+     */
+    create: function(recipient, userId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: recipient,
+            dataClass: Recipient,
+            path: {
+                userId: userId
+            }
+        });
+
+        return this._api.method('recipients_create', callback, options);
+    },
+
+    /**
+     * Get a Recipient
+     */
+    get: function(recipientId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                recipientId: recipientId
+            },
+            dataClass: Recipient
+        });
+
+        return this._api.method('recipients_get', callback, options);
+    },
+
+    /**
+     * Get all Recipients for a user
+     */
+    getUserRecipients: function(userId, callback, options) {
+        if (options && !options.hasOwnProperty('parameters')) {
+            Object.assign(options, {parameters: {...options}});
+        }
+        options = this._api._getOptions(callback, options, {
+            path: {
+                userId: userId
+            }
+        });
+
+        return this._api.method('recipients_get_all', callback, options);
+    },
+
+    /**
+     * Get a Recipient schema
+     */
+    getSchema: function(payoutMethodType, recipientType, currency, country, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                payoutMethodType: payoutMethodType,
+                recipientType: recipientType,
+                currency: currency,
+                country: country
+            },
+            dataClass: RecipientSchema
+        });
+
+        return this._api.method('recipients_get_schema', callback, options);
+    },
+
+    /**
+     * Get a Payment Methods
+     */
+    getPayoutMethods: function(country, currency, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                country: country,
+                currency: currency
+            },
+            dataClass: PayoutMethods
+        });
+
+        return this._api.method('recipients_get_payout_methods', callback, options);
+    },
+
+    /**
+     * Validates a Recipient
+     */
+    validate: function(recipient, userId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: recipient,
+            path: {
+                userId: userId
+            }
+        });
+
+        return this._api.method('recipients_validate', callback, options);
+    },
+
+    /**
+     * Deactivates a Recipient
+     */
+    deactivate: function(recipientId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: {
+                "Status": "DEACTIVATED"
+            },
+            dataClass: Recipient,
+            path: {
+                recipientId: recipientId
+            }
+        });
+
+        return this._api.method('recipients_deactivate', callback, options);
+    }
+
+});
+
+module.exports = Recipients;

package/lib/services/Refunds.js

@@ -0,0 +1,29 @@
+/**
+ * @module Refunds
+ * @desc [MangoPay Refunds API Reference](https://docs.mangopay.com/endpoints/v2.01/refunds)
+ */
+
+var Service = require('../service');
+var Refund = require('../models/Refund');
+
+var Refunds = Service.extend({
+    /**
+     * Get events
+     * @param {number} refundId     Refund id
+     * @param {Function} callback    Callback function
+     * @param {Object} options    Request options
+     * @return {Object} Request promise
+     */
+    get: function(refundId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                id: refundId
+            },
+            dataClass: Refund
+        });
+
+        return this._api.method('refunds_get', callback, options);
+    }
+});
+
+module.exports = Refunds;

package/lib/services/Regulatory.js

@@ -0,0 +1,29 @@
+var Service = require('../service');
+const CountryAuthorization = require("../models/CountryAuthorization");
+
+var Regulatory = Service.extend({
+
+    /**
+     * View the restrictions for a specific country
+     * @param countryCode: the code of the Country
+     */
+    getCountryAuthorizations: function(countryCode, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                countryCode: countryCode
+            },
+            dataClass: CountryAuthorization
+        });
+
+        return this._api.method('countries_get_one', callback, options);
+    },
+
+    /**
+     * View the restrictions for al countries
+     */
+    getAllCountriesAuthorizations: function(callback, options) {
+        return this._api.method('countries_get_all', callback, options);
+    }
+});
+
+module.exports = Regulatory;

package/lib/services/Reports.js

@@ -0,0 +1,61 @@
+/**
+ * @module Reports
+ * @desc [MangoPay Reports API Reference](https://docs.mangopay.com/endpoints/v2.01/reporting)
+ */
+
+var Service = require('../service');
+var Report = require('../models/Report');
+
+var Reports = Service.extend({
+    /**
+     * Create a report
+     * @param {Object}      report      Report Data
+     * @param {Function}    callback    Callback function
+     * @param {Object}      options     Request options
+     * @return {Object}                 Request promise
+     */
+    create: function(report, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: report,
+            dataClass: Report
+        });
+
+        if (!report.ReportType) {
+            throw new Error('Please specify ReportType in the report data (ex: "TRANSACTIONS", "WALLETS")')
+        }
+
+        var reportType = report.ReportType.toLowerCase();
+
+        return this._api.method('reports_' + report.ReportType.toLowerCase() + '_create', callback, options);
+    },
+
+    /**
+     * Get a report
+     * @param {number}      reportId    Report Id
+     * @param {Function}    callback    Callback function
+     * @param {Object}      options     Request options
+     * @return {Object}                 Request promise
+     */
+    get: function(reportId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                id: reportId
+            },
+            dataClass: Report
+        });
+
+        return this._api.method('reports_get', callback, options);
+    },
+
+    /**
+     * Get all reports
+     * @param {Function}    callback    Callback function
+     * @param {Object}      options     Request options
+     * @return {Object}                 Request promise
+     */
+    getAll: function(callback, options) {
+        return this._api.method('reports_all', callback, options);
+    }
+});
+
+module.exports = Reports;

package/lib/services/ReportsV2.js

@@ -0,0 +1,55 @@
+/**
+ * @module Reports 2025
+ * @desc [MangoPay Reports API Reference](https://mangopay-reports.mintlify.app/api-reference/reporting/report-object)
+ */
+
+var Service = require('../service');
+var ReportV2 = require('../models/ReportV2');
+
+var ReportsV2 = Service.extend({
+    /**
+     * Create a report
+     * @param {Object}      report      Report Data
+     * @param {Function}    callback    Callback function
+     * @param {Object}      options     Request options
+     * @return {Object}                 Request promise
+     */
+    create: function (report, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: report,
+            dataClass: ReportV2
+        });
+
+        return this._api.method('reports_create', callback, options);
+    },
+
+    /**
+     * Get a report
+     * @param {number}      reportId    Report Id
+     * @param {Function}    callback    Callback function
+     * @param {Object}      options     Request options
+     * @return {Object}                 Request promise
+     */
+    get: function (reportId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                id: reportId
+            },
+            dataClass: ReportV2
+        });
+
+        return this._api.method('reports_get_v2', callback, options);
+    },
+
+    /**
+     * Get all reports
+     * @param {Function}    callback    Callback function
+     * @param {Object}      options     Request options
+     * @return {Object}                 Request promise
+     */
+    getAll: function (callback, options) {
+        return this._api.method('reports_all_v2', callback, options);
+    }
+});
+
+module.exports = ReportsV2;

package/lib/services/Repudiations.js

@@ -0,0 +1,33 @@
+/**
+ * @module Repudiations
+ * @desc [MangoPay Repudiations API Reference](https://docs.mangopay.com/endpoints/v2.01/repudiations)
+ */
+
+var Service = require('../service');
+
+var Refund = require('../models/Refund');
+
+var Repudiations = Service.extend({
+
+    /**
+     * Gets list of Refunds of a Repudiation
+     * @param {number}      repudiationId       Repudiation identifier
+     * @param {function}    callback            Callback function
+     * @param {Object}      options             Request options
+     * @return {Object}                         Request promise
+     */
+    getRefunds: function(repudiationId, callback, options) {
+        if (options && !options.hasOwnProperty('parameters'))
+            Object.assign(options, {parameters: {...options}});
+        options = this._api._getOptions(callback, options, {
+            path: {
+                id: repudiationId
+            },
+            dataClass: Refund
+        });
+
+        return this._api.method("refunds_get_for_repudiation", callback, options);
+    }
+});
+
+module.exports = Repudiations;

package/lib/services/Responses.js

@@ -0,0 +1,23 @@
+/**
+ * @module Responses
+ */
+
+var _ = require('underscore');
+
+var Service = require('../service');
+
+var Responses = Service.extend({
+    /**
+     * Get response from previous call
+     * @param {Function} callback    Callback function
+     * @param {Object} options    Request options
+     * @return {Object} Request promise
+     */
+    get: function(callback, options) {
+        options = this._api._getOptions(callback, options);
+
+        return this._api.method('responses_get', callback, options);
+    }
+});
+
+module.exports = Responses;

package/lib/services/Settlements.js

@@ -0,0 +1,74 @@
+/**
+ * @module Settlements
+ */
+
+var Service = require('../service');
+var Settlement = require('../models/Settlement');
+
+var Settlements = Service.extend({
+    /**
+     * Upload a settlement file
+     * @param {Buffer} file       The settlement file to be uploaded
+     * @param {Function} callback Callback function
+     * @param {Object} options    Request options
+     * @return {Object}           Request promise
+     */
+    upload: function (file, callback, options) {
+        if (file === undefined || !Buffer.isBuffer(file)) {
+            throw new Error('The file needs to be a Buffer');
+        }
+
+        options = this._api._getOptions(callback, options, {
+            dataClass: Settlement,
+            data: {
+                file: file,
+                fileName: 'settlement_file.csv'
+            }
+        });
+
+        return this._api.multipartFormMethod('settlement_create', callback, options);
+    },
+
+    /**
+     * Get a settlement
+     * @param {string} settlementId Settlement Id
+     * @param {Function} callback   Callback function
+     * @param {Object} options      Request options
+     * @return {Object}             Request promise
+     */
+    get: function (settlementId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {id: settlementId},
+            dataClass: Settlement
+        });
+
+        return this._api.method('settlement_get', callback, options);
+    },
+
+    /**
+     * Update a settlement file
+     * @param {string} settlementId Settlement identifier
+     * @param {Buffer} file         The settlement file to be updated
+     * @param {Function} callback   Callback function
+     * @param {Object} options      Request options
+     * @return {Object}             Request promise
+     */
+    update: function (settlementId, file, callback, options) {
+        if (file === undefined || !Buffer.isBuffer(file)) {
+            throw new Error('The file needs to be a Buffer');
+        }
+
+        options = this._api._getOptions(callback, options, {
+            dataClass: Settlement,
+            data: {
+                file: file,
+                fileName: 'settlement_file.csv'
+            },
+            path: {id: settlementId}
+        });
+
+        return this._api.multipartFormMethod('settlement_update', callback, options);
+    },
+});
+
+module.exports = Settlements;

package/lib/services/Transfers.js

@@ -0,0 +1,87 @@
+/**
+ * @module Transfers
+ * @desc [MangoPay Transfers API Reference](https://docs.mangopay.com/endpoints/v2.01/transfers)
+ */
+
+var Service = require('../service');
+
+var Transfer = require('../models/Transfer');
+var Refund = require('../models/Refund');
+
+var Transfers = Service.extend({
+    /**
+     * Create new transfer
+     * @param {Object}  transfer    Transfer object
+     * @param {Function} callback    Callback function
+     * @param {Object} options    Request options
+     * @return {Object}            Request promise
+     */
+    create: function(transfer, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: transfer,
+            dataClass: Transfer
+        });
+
+        return this._api.method('transfers_create', callback, options);
+    },
+
+    /**
+     * Get transfer
+     * @param {number}  transferId      Transfer identifier
+     * @param {Function} callback    Callback function
+     * @param {Object} options    Request options
+     * @return {Object}                Request promise
+     */
+    get: function(transferId, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            path: {
+                id: transferId
+            },
+            dataClass: Transfer
+        });
+
+        return this._api.method('transfers_get', callback, options);
+    },
+
+    /**
+     * Create refund for transfer object
+     * @param {number}  transferId  Transfer identifier
+     * @param {Object}  refund      Refund object
+     * @param {Function} callback    Callback function
+     * @param {Object} options    Request options
+     * @return {Object}            Request promise
+     */
+    createRefund: function(transferId, refund, callback, options) {
+        options = this._api._getOptions(callback, options, {
+            data: refund,
+            path: {
+                id: transferId
+            },
+            dataClass: Refund
+        });
+
+        return this._api.method('transfers_createrefunds', callback, options);
+    },
+
+    /**
+     * Gets list of Refunds of a Transfer
+     * @param {number}      transferId      Transfer identifier
+     * @param {function}    callback        Callback function
+     * @param {Object}      options         Request options
+     * @return {Object}                     Request promise
+     */
+    getRefunds: function(transferId, callback, options) {
+        if (options && !options.hasOwnProperty('parameters'))
+            Object.assign(options, {parameters: {...options}});
+        options = this._api._getOptions(callback, options, {
+            path: {
+                id: transferId
+            },
+            dataClass: Refund
+        });
+
+        return this._api.method('refunds_get_for_transfer', callback, options);
+    }
+});
+
+module.exports = Transfers;