mangopay4-nodejs-sdk 1.64.0

package/typings/models/reportV2.d.ts

@@ -0,0 +1,145 @@
+import {CurrencyISO} from "../types";
+import {entityBase} from "./entityBase";
+
+export namespace reportV2 {
+    interface ReportFilterV2 {
+        /**
+         * The currency of the DebitedFunds, CreditedFunds, or Fees of the transactions (and therefore the wallets).
+         */
+        Currency?: CurrencyISO;
+
+        /**
+         * The unique identifier of the user referenced as the AuthorId or CreditedUserId of the transaction.
+         */
+        UserId?: string;
+
+        /**
+         * The unique identifier of the wallet referenced as the DebitedWalletId or CreditedWalletId of the transaction.
+         */
+        WalletId?: string;
+
+        PaymentMethod?: string;
+
+        Status?: string;
+
+        Type?: string;
+
+        IntentId?: string;
+
+        ExternalProviderName?: string;
+
+        Scheduled?: boolean;
+    }
+
+    interface ReportDataV2 extends entityBase.EntityBaseData {
+        /**
+         * The date and time at which the report was generated.
+         */
+        ReportDate: number;
+
+        /**
+         * The status of the report. Returned values: PENDING, READY_FOR_DOWNLOAD, FAILED, EXPIRED
+         */
+        Status: string;
+
+        /**
+         * The code indicating the result of the operation.
+         * This information is mostly used to handle errors or for filtering purposes.
+         */
+        ResultCode: string;
+
+        /**
+         * The explanation of the result code.
+         */
+        ResultMessage: string;
+
+        /**
+         * The format in which the report is going to be downloaded.
+         */
+        DownloadFormat: string;
+
+        /**
+         * The URL at which the report file can be downloaded when the Status is GENERATED.
+         */
+        DownloadURL: string;
+
+        /**
+         * The type of the report: USER_WALLET_TRANSACTIONS, COLLECTED_FEES
+         */
+        ReportType: string;
+
+        /**
+         * The sorting direction of the CreationDate column. By default, the generated report is sorted by ascending creation date.
+         */
+        Sort: string;
+
+        /**
+         * The date and time after which the report’s transaction was created, based on the transaction’s CreationDate.
+         */
+        AfterDate: number;
+
+        /**
+         * The date and time before which the report’s transaction was created, based on the transaction’s CreationDate.
+         */
+        BeforeDate: number;
+
+        /**
+         * The filers to apply.
+         * The Currency and WalletId cannot be used together.
+         */
+        Filters: ReportFilterV2;
+
+        /**
+         * The data columns to be included in the report.
+         */
+        Columns: ReportColumn[];
+    }
+
+    interface CreateReportV2 {
+        /**
+         * Custom data that you can add to this object.
+         */
+        Tag?: string;
+
+        /**
+         * The format in which the report is going to be downloaded.
+         */
+        DownloadFormat: string;
+
+        /**
+         * The type of the report: USER_WALLET_TRANSACTIONS, COLLECTED_FEES
+         */
+        ReportType: string;
+
+        /**
+         * The sorting direction of the CreationDate column. By default, the generated report is sorted by ascending creation date.
+         */
+        Sort?: string;
+
+        /**
+         * The date and time after which the report’s transaction was created, based on the transaction’s CreationDate.
+         */
+        AfterDate: number;
+
+        /**
+         * The date and time before which the report’s transaction was created, based on the transaction’s CreationDate.
+         */
+        BeforeDate: number;
+
+        /**
+         * The filers to apply.
+         * The Currency and WalletId cannot be used together.
+         */
+        Filters?: ReportFilterV2;
+
+        /**
+         * The data columns to be included in the report.
+         */
+        Columns?: string[];
+    }
+
+    interface ReportColumn {
+        Name: string;
+        IsDefault: boolean;
+    }
+}

package/typings/models/repudiation.d.ts

@@ -0,0 +1,26 @@
+import { transaction } from "./transaction";
+import { refund } from "./refund";
+
+export namespace repudiation {
+    interface RepudiationData extends transaction.TransactionData {
+        /**
+         * The nature of the transaction
+         */
+        Nature: "REPUDIATION";
+
+        /**
+         * The initial transaction ID
+         */
+        InitialTransactionId: string;
+
+        /**
+         * The initial transaction type
+         */
+        InitialTransactionType: transaction.TransactionType;
+
+        /**
+         * Contains info about the reason for refund
+         */
+        RefundReason: refund.RefundReason;
+    }
+}

package/typings/models/securityInfo.d.ts

@@ -0,0 +1,12 @@
+export namespace securityInfo {
+    type AVSResult =
+        | "NO_CHECK"
+        | "NO_MATCH"
+        | "ADDRESS_MATCH_ONLY"
+        | "POSTAL_CODE_MATCH_ONLY"
+        | "FULL_MATCH";
+
+    interface SecurityInfoData {
+        AVSResult: AVSResult;
+    }
+}

package/typings/models/settlement.d.ts

@@ -0,0 +1,50 @@
+import {entityBase} from "./entityBase";
+import {Timestamp} from "../types";
+
+export namespace settlement {
+    interface SettlementData extends entityBase.EntityBaseData {
+        /**
+         * The unique identifier of the settlement object
+         */
+        SettlementId: string;
+
+        /**
+         * The status of the settlement
+         */
+        Status: string;
+
+        /**
+         * The date at which the settlement was created by the external provider
+         */
+        SettlementDate: Timestamp;
+
+        /**
+         * The name of the external provider
+         */
+        ExternalProviderName: string;
+
+        /**
+         * The total amount declared through intent API calls with the following calculation:
+         * (Sum of captured intents) - (Sum of refunds amounts) + (Sum of refund reversed amounts) - (Sum of DISPUTED disputes) + (Sum of WON disputes)
+         */
+        DeclaredIntentAmount: number;
+
+        /**
+         * The total fees charged by the external provider
+         */
+        ExternalProcessorFeesAmount: number;
+
+        /**
+         * The total amount due to the platform (to be held in escrow wallet).
+         * This amount correspond to the TotalSettlementAmount from the settlement file.
+         *
+         * A negative amount will result in this parameter being set to zero, indicating no incoming funds to the escrow wallet.
+         */
+        ActualSettlementAmount: number;
+
+        /**
+         * The difference between ActualSettlementAmount and the amount received on the escrow wallet
+         */
+        FundsMissingAmount: number;
+    }
+}

package/typings/models/settlementTransfer.d.ts

@@ -0,0 +1,37 @@
+import { transaction } from "./transaction";
+import { refund } from "./refund";
+import { PickPartialRequired } from "../types";
+
+export namespace settlementTransfer {
+    interface SettlementTransferData extends transaction.TransactionData {
+        /**
+         * The nature of the transaction
+         */
+        Nature: "SETTLEMENT";
+
+        /**
+         * The ID of the associated repudiation transaction
+         */
+        RepudiationId: string;
+
+        /**
+         * The initial transaction ID
+         */
+        InitialTransactionId: string;
+
+        /**
+         * The initial transaction type
+         */
+        InitialTransactionType: transaction.TransactionType;
+
+        /**
+         * Contains info about the reason for refund
+         */
+        RefundReason: refund.RefundReason;
+    }
+
+    interface CreateSettlementTransfer extends PickPartialRequired<SettlementTransferData,
+        "Tag",
+        "AuthorId" | "DebitedFunds" | "Fees"> {
+    }
+}

package/typings/models/shipping.d.ts

@@ -0,0 +1,37 @@
+import { address } from "./address";
+
+export namespace shipping {
+    interface ShippingData {
+        /**
+         * The name of the user
+         */
+        FirstName: string;
+
+        /**
+         * The last name of the user
+         */
+        LastName: string;
+
+        /**
+         * The address
+         */
+        Address: address.AddressData;
+    }
+
+    interface CreateShipping {
+        /**
+         * The name of the user
+         */
+        FirstName: string;
+
+        /**
+         * The last name of the user
+         */
+        LastName: string;
+
+        /**
+         * The address
+         */
+        Address: address.CreateAddress;
+    }
+}

package/typings/models/shippingAddress.d.ts

@@ -0,0 +1,15 @@
+import { address } from "./address";
+
+export namespace shippingAddress {
+    interface ShippingAddressData {
+        /**
+         * Name of the shipping recipient
+         */
+        RecipientName: string;
+
+        /**
+         * The shipping address
+         */
+        Address: address.AddressType;
+    }
+}

package/typings/models/transaction.d.ts

@@ -0,0 +1,85 @@
+import { Timestamp } from "../types";
+import { entityBase } from "./entityBase";
+import { money } from "./money";
+
+export namespace transaction {
+    import MoneyData = money.MoneyData;
+
+    type TransactionNature = "REGULAR" | "REPUDIATION" | "REFUND" | "SETTLEMENT";
+
+    type TransactionType = "PAYIN" | "TRANSFER" | "PAYOUT" | "CARD_VALIDATION" | "CONVERSION";
+
+    type TransactionStatus = "CREATED" | "SUCCEEDED" | "FAILED";
+
+    interface TransactionData extends entityBase.EntityBaseData {
+        /**
+         * Information about the funds that are being debited
+         */
+        DebitedFunds: MoneyData;
+
+        /**
+         * Details about the funds that are being credited (DebitedFunds – Fees = CreditedFunds)
+         */
+        CreditedFunds: MoneyData;
+
+        /**
+         * Information about the fees that were taken by the client for this transaction (and were hence transferred to the Client's platform wallet)
+         */
+        Fees: MoneyData;
+
+        /**
+         * The ID of the wallet that was debited
+         */
+        DebitedWalletId: string;
+
+        /**
+         * The ID of the wallet where money will be credited
+         */
+        CreditedWalletId: string;
+
+        /**
+         * A user's ID
+         */
+        AuthorId: string;
+
+        /**
+         * The user ID who is credited (defaults to the owner of the wallet)
+         */
+        CreditedUserId: string;
+
+        /**
+         * The nature of the transaction
+         */
+        Nature: TransactionNature;
+
+        /**
+         * The status of the transaction
+         */
+        Status: TransactionStatus;
+
+        /**
+         * When the transaction happened
+         */
+        ExecutionDate: Timestamp;
+
+        /**
+         * The result code
+         */
+        ResultCode: string;
+
+        /**
+         * A verbal explanation of the ResultCode
+         */
+        ResultMessage: string;
+
+        /**
+         * The type of the transaction
+         */
+        Type: TransactionType;
+
+        /**
+         * The identifier of a deposit.
+         */
+        DepositId?: string;
+    }
+}

package/typings/models/transfer.d.ts

@@ -0,0 +1,119 @@
+import { transaction } from "./transaction";
+import { Timestamp } from "../types";
+import { entityBase } from "./entityBase";
+import { money } from "./money";
+import { user } from "./user";
+
+export namespace transfer {
+    import MoneyData = money.MoneyData;
+
+    interface TransferData extends entityBase.EntityBaseData {
+        /**
+         * Information about the funds that are being debited
+         */
+        DebitedFunds: MoneyData;
+
+        /**
+         * Details about the funds that are being credited (DebitedFunds – Fees = CreditedFunds)
+         */
+        CreditedFunds: MoneyData;
+
+        /**
+         * Information about the fees that were taken by the client for this transaction (and were hence transferred to the Client's platform wallet)
+         */
+        Fees: MoneyData;
+
+        /**
+         * The ID of the wallet that was debited
+         */
+        DebitedWalletId: string;
+
+        /**
+         * The ID of the wallet where money will be credited
+         */
+        CreditedWalletId: string;
+
+        /**
+         * A user's ID
+         */
+        AuthorId: string;
+
+        /**
+         * The user ID who is credited (defaults to the owner of the wallet)
+         */
+        CreditedUserId: string;
+
+        /**
+         * The nature of the transaction
+         */
+        Nature: transaction.TransactionNature;
+
+        /**
+         * The status of the transaction
+         */
+        Status: transaction.TransactionStatus;
+
+        /**
+         * When the transaction happened
+         */
+        ExecutionDate: Timestamp;
+
+        /**
+         * The result code
+         */
+        ResultCode: string;
+
+        /**
+         * A verbal explanation of the ResultCode
+         */
+        ResultMessage: string;
+
+        /**
+         * The type of the transaction
+         */
+        Type: "TRANSFER";
+
+        ScaContext: string;
+
+        PendingUserAction: user.PendingUserActionData;
+    }
+
+    interface CreateTransfer {
+        /**
+         * Custom data that you can add to this item
+         */
+        Tag?: string;
+
+        /**
+         * A user's ID
+         */
+        AuthorId: string;
+
+        /**
+         * The user ID who is credited (defaults to the owner of the wallet)
+         */
+        CreditedUserId?: string;
+
+        /**
+         * Information about the funds that are being debited
+         */
+        DebitedFunds: MoneyData;
+
+        /**
+         * Information about the fees that were taken by the client for this transaction (and were hence transferred to the Client's platform wallet)
+         */
+        Fees: MoneyData;
+
+        /**
+         * The ID of the wallet that was debited
+         */
+        DebitedWalletId: string;
+
+        /**
+         * The ID of the wallet where money will be credited
+         */
+        CreditedWalletId: string;
+
+        ScaContext?: string;
+    }
+}

package/typings/models/uboDeclaration.d.ts

@@ -0,0 +1,100 @@
+import { Timestamp, ValueOf } from "../types";
+import { birthplace } from "./birthplace";
+import { address } from "./address";
+import { entityBase } from "./entityBase";
+import { enums } from "../enums";
+
+export namespace uboDeclaration {
+    interface UboDeclarationData extends entityBase.EntityBaseData {
+        /**
+         * ID of the user
+         */
+        UserId: string;
+        /**
+         * cannot be modified by clients
+         */
+        ProcessedDate: Timestamp;
+        /**
+         * Declaration status (one of UboDeclarationStatus)
+         */
+        Status: ValueOf<enums.IUboDeclarationStatus>;
+        /**
+         * Array of reasons why the declaration was refused
+         * Values as declared in UboDeclarationRefusedReasonType.
+         */
+        Reason: ValueOf<enums.IUboDeclarationRefusedReasonType>;
+        /**
+         * Explanation of why the declaration was refused.
+         */
+        Message: string;
+        /**
+         * Table of ubos (declared in Ubo)
+         */
+        Ubos: [];
+    }
+
+    interface UboData extends entityBase.EntityBaseData {
+        FirstName: string;
+
+        LastName: string;
+
+        Address: address.AddressType;
+
+        Nationality: string;
+
+        Birthday: Timestamp;
+
+        Birthplace: birthplace.Birthplace;
+
+        isActive: boolean;
+    }
+
+    interface CreateUbo {
+        FirstName: string;
+
+        LastName: string;
+
+        Address: address.AddressType;
+
+        Nationality: string;
+
+        Birthday: Timestamp;
+
+        Birthplace: birthplace.Birthplace;
+    }
+
+    interface UpdateUbo {
+        Id: string;
+
+        FirstName?: string;
+
+        LastName?: string;
+
+        Address?: address.AddressType;
+
+        Nationality?: string;
+
+        Birthday?: Timestamp;
+
+        Birthplace?: birthplace.Birthplace;
+
+        isActive?: boolean;
+    }
+
+    interface CreateUboDeclaration {
+        Ubos?: string[];
+    }
+
+    interface UpdateUboDeclaration {
+        Id: string;
+
+        Tag?: string;
+
+        Status?: "VALIDATION_ASKED";
+
+        /**
+         * An array of UserIDs declared as Ultimate Beneficial Owners of a BUSINESS Legal User.
+         */
+        Ubos?: string[];
+    }
+}