mangopay4-nodejs-sdk 1.64.0

package/typings/services/PayOuts.d.ts

@@ -0,0 +1,34 @@
+import { payOut } from "../models/payOut";
+import { refund } from "../models/refund";
+import { base } from "../base";
+import MethodOverload = base.MethodOverload;
+
+export class PayOuts {
+    /**
+     * Create new pay-out
+     * @param payOut
+     * @param options
+     */
+    create: MethodOverload<payOut.CreatePayOut, payOut.PayOutData>;
+
+    /**
+     * Get payout
+     * @param payOutId
+     * @param options
+     */
+    get: MethodOverload<string, payOut.PayOutData>;
+
+    /**
+     * Gets list of Refunds of a PayOut
+     * @param payOutId
+     * @param options
+     */
+    getRefunds: MethodOverload<string, refund.RefundData[]>;
+
+    /**
+     * Check Instant PayOut Eligibility
+     * @param payOut
+     * @param options
+     */
+    checkEligibility: MethodOverload<payOut.CheckPayOutEligibility, payOut.CheckPayOutEligibilityData>;
+}

package/typings/services/Recipients.d.ts

@@ -0,0 +1,55 @@
+import { base } from "../base";
+import { recipient } from "../models/recipient";
+import MethodOverload = base.MethodOverload;
+import TwoArgsMethodOverload = base.TwoArgsMethodOverload;
+import FourArgsMethodOverload = base.FourArgsMethodOverload;
+
+export class Recipients {
+    /**
+     * Create a Recipient
+     * @param recipient
+     * @param userId
+     */
+    create: TwoArgsMethodOverload<recipient.CreateRecipientData, string, recipient.RecipientData>;
+
+    /**
+     * Get a Recipient
+     * @param recipientId
+     */
+    get: MethodOverload<string, recipient.RecipientData>;
+
+    /**
+     * Get all Recipients for a user
+     * @param userId
+     */
+    getUserRecipients: MethodOverload<string, recipient.RecipientData[]>;
+
+    /**
+     * Get a Recipient schema
+     * @param payoutMethodType
+     * @param recipientType
+     * @param currency
+     * @param country
+     */
+    getSchema: FourArgsMethodOverload<string, string, string, string, recipient.RecipientSchemaData>;
+
+    /**
+     * Get a Payment Methods
+     * @param country
+     * @param currency
+     */
+    getPayoutMethods: TwoArgsMethodOverload<string, string, recipient.PayoutMethodData>;
+
+    /**
+     * Validates a Recipient
+     * @param recipient
+     * @param userId
+     */
+    validate: TwoArgsMethodOverload<recipient.CreateRecipientData, string, void>;
+
+    /**
+     * Deactivates a Recipient
+     * @param recipientId
+     */
+    deactivate: MethodOverload<string, recipient.RecipientData>;
+}

package/typings/services/Refunds.d.ts

@@ -0,0 +1,12 @@
+import { refund } from "../models/refund";
+import { base } from "../base";
+import MethodOverload = base.MethodOverload;
+
+export class Refunds {
+    /**
+     * Get events
+     * @param refundId
+     * @param options
+     */
+    get: MethodOverload<string, refund.RefundData>;
+}

package/typings/services/Regulatory.d.ts

@@ -0,0 +1,17 @@
+import { base } from "../base";
+import { countryAuthorization } from "../models/countryAuthorization";
+import MethodOverload = base.MethodOverload;
+import NoArgMethodOverload = base.NoArgMethodOverload;
+
+export class Regulatory {
+    /**
+     * View the restrictions for a specific country
+     * @param countryCode: the code of the Country
+     */
+    getCountryAuthorizations: MethodOverload<string, countryAuthorization.CountryAuthorizationData>;
+
+    /**
+     * View the restrictions for al countries
+     */
+    getAllCountriesAuthorizations: NoArgMethodOverload<countryAuthorization.CountryAuthorizationData[]>;
+}

package/typings/services/Reports.d.ts

@@ -0,0 +1,26 @@
+import { report } from "../models/report";
+import { base } from "../base";
+import MethodOverload = base.MethodOverload;
+import NoArgMethodOverload = base.NoArgMethodOverload;
+
+export class Reports {
+    /**
+     * Create a report
+     * @param report
+     * @param options
+     */
+    create: MethodOverload<report.CreateReport, report.ReportData>;
+
+    /**
+     * Get a report
+     * @param reportId
+     * @param options
+     */
+    get: MethodOverload<string, report.ReportData>;
+
+    /**
+     * Get all reports
+     * @param options
+     */
+    getAll: NoArgMethodOverload<report.ReportData[]>;
+}

package/typings/services/ReportsV2.d.ts

@@ -0,0 +1,26 @@
+import {reportV2} from "../models/reportV2";
+import {base} from "../base";
+import MethodOverload = base.MethodOverload;
+import NoArgMethodOverload = base.NoArgMethodOverload;
+
+export class ReportsV2 {
+    /**
+     * Create a report
+     * @param report
+     * @param options
+     */
+    create: MethodOverload<reportV2.CreateReportV2, reportV2.ReportDataV2>;
+
+    /**
+     * Get a report
+     * @param reportId
+     * @param options
+     */
+    get: MethodOverload<string, reportV2.ReportDataV2>;
+
+    /**
+     * Get all reports
+     * @param options
+     */
+    getAll: NoArgMethodOverload<reportV2.ReportDataV2[]>;
+}

package/typings/services/Repudiations.d.ts

@@ -0,0 +1,12 @@
+import { refund } from "../models/refund";
+import { base } from "../base";
+import MethodOverload = base.MethodOverload;
+
+export class Repudiations {
+    /**
+     * Gets list of Refunds of a Repudiation
+     * @param repudiationId
+     * @param options
+     */
+    getRefunds: MethodOverload<string, refund.RefundData[]>;
+}

package/typings/services/Responses.d.ts

@@ -0,0 +1,10 @@
+import { base } from "../base";
+import NoArgMethodOverload = base.NoArgMethodOverload;
+
+export class Responses {
+    /**
+     * Get response from previous call
+     * @param options
+     */
+    get: NoArgMethodOverload<any[]>;
+}

package/typings/services/Settlements.d.ts

@@ -0,0 +1,28 @@
+import {base} from "../base";
+import {settlement} from "../models/settlement";
+import MethodOverload = base.MethodOverload;
+import TwoArgsMethodOverload = base.TwoArgsMethodOverload;
+
+export class Settlements {
+    /**
+     * Upload a settlement file
+     * @param {Buffer} file    The settlement file to be uploaded
+     * @param {Object} options Request options
+     */
+    upload: MethodOverload<string, settlement.SettlementData>;
+
+    /**
+     * Get a settlement
+     * @param {string} settlementId
+     * @param {Object} options
+     */
+    get: MethodOverload<string, settlement.SettlementData>;
+
+    /**
+     * Update a settlement file
+     * @param {string} settlementId The settlement identifier
+     * @param {Buffer} file         The settlement file to be uploaded
+     * @param {Object} options      Request options
+     */
+    update: TwoArgsMethodOverload<string, string, settlement.SettlementData>;
+}

package/typings/services/Transfers.d.ts

@@ -0,0 +1,38 @@
+import { transfer } from "../models/transfer";
+import { refund } from "../models/refund";
+import { base } from "../base";
+import MethodOverload = base.MethodOverload;
+import TwoArgsMethodOverload = base.TwoArgsMethodOverload;
+
+export class Transfers {
+    /**
+     * Create new transfer
+     * @param transfer
+     * @param options
+     */
+    create: MethodOverload<transfer.CreateTransfer, transfer.TransferData>;
+
+    /**
+     * Get transfer
+     * @param transferId
+     * @param options
+     */
+    get: MethodOverload<string, transfer.TransferData>;
+
+    /**
+     * Create refund for transfer object
+     * @param transferId
+     * @param refund
+     * @param options
+     */
+    createRefund: TwoArgsMethodOverload<string,
+        refund.CreateTransferRefund,
+        refund.RefundData>;
+
+    /**
+     * Gets list of Refunds of a Transfer
+     * @param transferId
+     * @param options
+     */
+    getRefunds: MethodOverload<string, refund.RefundData[]>;
+}

package/typings/services/UboDeclarations.d.ts

@@ -0,0 +1,81 @@
+import { uboDeclaration } from "../models/uboDeclaration";
+import { base } from "../base";
+import TwoArgsMethodOverload = base.TwoArgsMethodOverload;
+import MethodOverload = base.MethodOverload;
+import ThreeArgsMethodOverload = base.ThreeArgsMethodOverload;
+
+/**
+ * An UBO Declaration is an electronic version of the previous KYC document "Shareholder Declaration", in order to declare all the Ultimate Beneficial Owners of a BUSINESS-typed legal User
+ * (ie the shareholders with >25% of capital or voting rights).
+ *
+ * 1. Create each Ultimate Beneficial Owner as a Natural User, who must have a "DECLARATIVE" Capacity.
+ * 2. Create a new UBO Declaration for your legal user, and link every Ultimate Beneficial Owners created previously thanks to DeclaredUBOs.
+ *  - This list can be empty if your legal user has no Ultimate Beneficial Owner, or no eligible one (ie. no Ultimate Beneficial Owner that owns more than 25% of this company).
+ * 3. Edit the UBODeclaration object and set the Status field to "VALIDATION_ASKED" (instead of "CREATED")
+ * 4. The demand is received by our team and once processed, it will either get a "VALIDATED" status, or "REFUSED" with more information provided in the RefusedReasonTypes parameter
+ *
+ * Note that UBO declarations are not yet a requirement for your user to be KYC verified and are optional at this stage
+ */
+export class UboDeclarations {
+    /**
+     * @deprecated Use the 'getById' method, which doesn't require passing the userId.
+     *
+     * Retrieves a UBO declaration object from the API.
+     * @param {String} userId User Unique identifier
+     * @param {String} id Unique identifier
+     * @param {Object} options
+     */
+    get: TwoArgsMethodOverload<string, string, uboDeclaration.UboDeclarationData>;
+
+    /**
+     * Retrieves a UBO declaration object from the API.
+     * @param {String} id Unique identifier
+     * @param {Object} options
+     */
+    getById: MethodOverload<string, uboDeclaration.UboDeclarationData>;
+
+    /**
+     * Updates a UBO declaration entity.
+     * @param {String} userId User Unique Identifier
+     * @param {Object} uboDeclaration Updated UBO declaration entity - must have ID!
+     * @param {Object} options
+     */
+    update: TwoArgsMethodOverload<
+        string,
+        uboDeclaration.UpdateUboDeclaration,
+        uboDeclaration.UboDeclarationData
+        >;
+
+    /**
+     * Create a UBO declaration object from the API
+     * @param {String} userId user Unique identifier
+     * @param {Object} options
+     */
+    create: MethodOverload<string, uboDeclaration.UboDeclarationData>;
+
+    /**
+     * @param {String} userId user Uniquer identifier
+     */
+    getAll: MethodOverload<string, uboDeclaration.UboDeclarationData[]>;
+
+    /**
+     * @param {String} userId User Uniquer identifier
+     * @param {String} uboDeclarationId UboDeclaration Uniquer identifier
+     * @param {Object} Ubo object
+     */
+    createUbo: ThreeArgsMethodOverload<string, string, uboDeclaration.CreateUbo, uboDeclaration.UboData>;
+
+    /**
+     * @param {String} userId User Uniquer identifier
+     * @param {String} uboDeclarationId UboDeclaration Uniquer identifier
+     * @param {String} uboId Ubo Uniquer identifier
+     */
+    getUbo: ThreeArgsMethodOverload<string, string, string, uboDeclaration.UboData>;
+
+    /**
+     * @param {String} userId User Uniquer identifier
+     * @param {String} uboDeclarationId UboDeclaration Uniquer identifier
+     * @param {Object} Ubo object
+     */
+    updateUbo: ThreeArgsMethodOverload<string, string, uboDeclaration.UpdateUbo, uboDeclaration.UboData>;
+}

package/typings/services/Users.d.ts

@@ -0,0 +1,308 @@
+import { user } from "../models/user";
+import { Models } from "../models";
+import { bankAccount } from "../models/bankAccount";
+import { wallet } from "../models/wallet";
+import { transaction } from "../models/transaction";
+import { card } from "../models/card";
+import { kycDocument } from "../models/kycDocument";
+import { money } from "../models/money";
+import { cardPreAuthorization } from "../models/cardPreauthorization";
+import { base } from "../base";
+import MethodOverload = base.MethodOverload;
+import NoArgMethodOverload = base.NoArgMethodOverload;
+import TwoArgsMethodOverload = base.TwoArgsMethodOverload;
+import ThreeArgsMethodOverload = base.ThreeArgsMethodOverload;
+
+export class Users {
+    /**
+     * Create a new user
+     * @param user
+     */
+    create: MethodOverload<user.CreateUserLegalData, user.UserLegalData> &
+        MethodOverload<user.CreateUserNaturalData, user.UserNaturalData> &
+        MethodOverload<user.CreateUserNaturalPayerData, user.UserNaturalData> &
+        MethodOverload<user.CreateUserNaturalOwnerData, user.UserNaturalData> &
+        MethodOverload<user.CreateUserLegalPayerData, user.UserLegalData> &
+        MethodOverload<user.CreateUserLegalOwnerData, user.UserLegalData> &
+        MethodOverload<user.CreateUserNaturalScaData, user.UserNaturalScaData> &
+        MethodOverload<user.CreateUserLegalScaData, user.UserLegalScaData>;
+
+    /**
+     * Update a user
+     * @param user
+     * @param options
+     */
+    update: MethodOverload<Models.UserLegal | user.UpdateUserLegalData, user.UserLegalData> &
+        MethodOverload<Models.UserNatural | user.UpdateUserNaturalData, user.UserNaturalData>;
+
+    /**
+     * Modify details for a Natural/Legal Payer or Owner without changing category
+     * @param user
+     * @param options
+     */
+    updateSca: MethodOverload<user.UpdateUserLegalScaData, user.UserLegalScaData> &
+        MethodOverload<user.UpdateUserNaturalScaData, user.UserNaturalScaData>;
+
+    /**
+     * Get natural or legal user by ID
+     * @param userId
+     * @param options
+     */
+    get: MethodOverload<string, user.UserLegalData | user.UserNaturalData>;
+
+    /**
+     * Get natural or legal SCA user by ID
+     * @param userId
+     * @param options
+     */
+    getSca: MethodOverload<string, user.UserLegalScaData | user.UserNaturalScaData>;
+
+    /**
+     * Get natural user by ID
+     * @param userId
+     * @param options
+     */
+    getNatural: MethodOverload<string, user.UserNaturalData>;
+
+    /**
+     * Get natural SCA user by ID
+     * @param userId
+     * @param options
+     */
+    getNaturalSca: MethodOverload<string, user.UserNaturalScaData>;
+
+    /**
+     * Get legal user by ID
+     * @param userId
+     * @param options
+     */
+    getLegal: MethodOverload<string, user.UserLegalData>;
+
+    /**
+     * Get legal SCA user by ID
+     * @param userId
+     * @param options
+     */
+    getLegalSca: MethodOverload<string, user.UserLegalScaData>;
+
+    /**
+     * Get all users
+     */
+    getAll: NoArgMethodOverload<
+        Array<user.UserLegalData | user.UserNaturalData>
+        >;
+
+    /**
+     * Create bank account for user
+     * @param userId
+     * @param bankAccount
+     * @param options
+     */
+    createBankAccount:
+        TwoArgsMethodOverload<string, bankAccount.USDetails, bankAccount.USData> &
+        TwoArgsMethodOverload<string, bankAccount.OtherDetails, bankAccount.OtherData> &
+        TwoArgsMethodOverload<string, bankAccount.IBANDetails, bankAccount.IBANData> &
+        TwoArgsMethodOverload<string, bankAccount.GBDetails, bankAccount.GBData> &
+        TwoArgsMethodOverload<string, bankAccount.CADetails, bankAccount.CAData>;
+
+    /**
+     * Deactivate a bank account
+     *
+     * Note that once deactivated, a bank account can't be reactivated afterwards
+     * @param userId
+     * @param bankAccountId
+     * @param options
+     */
+    deactivateBankAccount: TwoArgsMethodOverload<string, string, bankAccount.Data>;
+
+    /**
+     * Get all bank accounts for user
+     * @param userId
+     * @param options
+     */
+    getBankAccounts: MethodOverload<string, bankAccount.Data[]>;
+
+    /**
+     * Get all bank accounts for user
+     * @param userId
+     * @param bankAccountId
+     * @param options
+     */
+    getBankAccount: TwoArgsMethodOverload<string, string, bankAccount.Data>;
+
+    /**
+     * Get all wallets accounts for user
+     */
+    getWallets: MethodOverload<string, wallet.WalletData[]>;
+
+    /**
+     * Get all transactions for user
+     * @param userId
+     * @param options
+     */
+    getTransactions: MethodOverload<string, transaction.TransactionData[]>;
+
+    /**
+     * Get all cards for user
+     * @param userId
+     * @param options
+     */
+    getCards: MethodOverload<string, card.CardData[]>;
+
+    /**
+     * Create new KYC document
+     * @param  userId
+     * @param  kycDocument
+     * @param  options
+     */
+    createKycDocument: TwoArgsMethodOverload<
+        string,
+        kycDocument.CreateKycDocument,
+        kycDocument.KycDocumentData
+        >;
+
+    /**
+     * Get all KYC documents for user
+     * @param userId
+     * @param options
+     */
+    getKycDocuments: MethodOverload<string, kycDocument.KycDocumentData[]>;
+
+    /**
+     * Get KYC document
+     * @param userId
+     * @param kycDocumentId
+     * @param options
+     */
+    getKycDocument: TwoArgsMethodOverload<
+        string,
+        string,
+        kycDocument.KycDocumentData
+        >;
+
+    /**
+     * Update status of KYC Document (Currently only allows for submitting the document)
+     * @param userId
+     * @param kycDocument
+     * @param options
+     */
+    updateKycDocument: TwoArgsMethodOverload<
+        string,
+        kycDocument.SubmitKycDocument,
+        kycDocument.KycDocumentData
+        >;
+
+    /**
+     * Create page for KYC document
+     * @param userId
+     * @param kycDocumentId
+     * @param kycPage
+     * @param options
+     */
+    createKycPage: ThreeArgsMethodOverload<
+        string,
+        string,
+        kycDocument.CreateKycPage,
+        kycDocument.KycDocumentData
+        >;
+
+    /**
+     * Create page for KYC document
+     * @param userId
+     * @param kycDocumentId
+     * @param filePath
+     * @param options
+     */
+    createKycPageFromFile: ThreeArgsMethodOverload<
+        string,
+        string,
+        string,
+        kycDocument.KycDocumentData
+        >;
+
+    /**
+     * Get users's EMoney
+     * @param userId
+     * @param options
+     */
+    getEMoney: MethodOverload<string, money.EMoneyData>;
+
+    /**
+     * Get all user preauthorizations
+     * @param userId
+     * @param options
+     */
+    getPreAuthorizations: MethodOverload<
+        string,
+        cardPreAuthorization.CardPreAuthorizationData[]
+        >;
+
+    /**
+     * This endpoint allows you to transition a user whose UserCategory is PAYER into an OWNER
+     * by providing the required information and redirecting them on the PendingUserAction.RedirectUrl
+     * response value to complete SCA enrollment.
+     *
+     * For Natural Users, optionally, you can update the Email and provide or update the PhoneNumber
+     * and PhoneNumberCountry before SCA redirection.
+     *
+     * For Legal Users, optionally, you can update the LegalRepresentative.Email and provide or update
+     * the LegalRepresentative.PhoneNumber and LegalRepresentative.PhoneNumberCountry before SCA redirection.
+     *
+     * @param user
+     * @param options
+     */
+    categorize: MethodOverload<user.CategorizeUserNatural, user.UserNaturalScaData> &
+        MethodOverload<user.CategorizeUserLegal, user.UserLegalScaData>;
+
+    /**
+     * If UserCategory is OWNER, this endpoint allows you to enroll a user in SCA.
+     * Your platform needs to retrieve the returned PendingUserAction.RedirectUrl,
+     * add an encoded returnUrl query parameter for them to be returned to after the SCA session,
+     * and redirect the userGet natural or legal user by ID
+     *
+     * @param userId
+     * @param options
+     */
+    enroll: MethodOverload<string, user.UserEnrollmentResult>;
+
+    /**
+     * Manage user consent
+     *
+     * @param userId
+     * @param options
+     */
+    manageConsent: MethodOverload<string, user.UserConsent>;
+
+    /**
+     * Close a user (change status to CLOSED). The resource remains available for historical purposes.
+     * @param user
+     * @param options
+     */
+    close: MethodOverload<user.UserNaturalData | user.UserNaturalScaData, void> &
+        MethodOverload<user.UserLegalData | user.UserLegalScaData, void>;
+
+    /**
+     * Validate the format of User data
+     * @param dataValidation
+     * @param options
+     */
+    validateDataFormat: MethodOverload<user.UserDataFormatValidation, user.UserDataFormatValidation>
+
+    /**
+     * Get user regulatory
+     * @param {string} userId User identifier
+     * @param {Function} callback Callback function
+     * @param {Object} options Request options
+     * @return {Object} Request promise
+     */
+    getRegulatory: MethodOverload<string, user.RegulatoryData>
+
+    /**
+     * Get user block status
+     * @param {string} userId User identifier
+     * @param {Function} callback Callback function
+     * @param {Object} options Request options
+     * @return {Object} Request promise
+     */
+    getBlockStatus: MethodOverload<string, user.RegulatoryData>
+}