mangopay4-nodejs-sdk 1.64.0

package/typings/models/payOut.d.ts

@@ -0,0 +1,144 @@
+import { Omit } from "../types";
+import { transfer } from "./transfer";
+import { enums } from "../enums";
+import { money } from "./money";
+import { base } from "../base";
+import { recipient } from "./recipient";
+
+export namespace payOut {
+    import MoneyData = money.MoneyData;
+    import FallbackReasonData = base.FallbackReasonData;
+    import PayoutPaymentRefData = base.PayoutPaymentRefData;
+    import VerificationOfPayee = recipient.VerificationOfPayee;
+
+    type PayoutModeRequestedType = "STANDARD" | "INSTANT_PAYMENT" | "INSTANT_PAYMENT_ONLY" | "RTGS_PAYMENT";
+    type PayoutModeAppliedType = "STANDARD" | "INSTANT_PAYMENT" | "RTGS_PAYMENT" | "PENDING_RESPONSE";
+
+    interface PayOutData extends Omit<transfer.TransferData, "Type"> {
+        /**
+         * The type of the transaction
+         */
+        Type: "PAYOUT";
+
+        PaymentType: enums.IPayOutPaymentType["BankWire"];
+
+        /**
+         * An ID of a Bank Account
+         */
+        BankAccountId: string;
+
+        /**
+         * A custom reference you wish to appear on the user’s bank statement (your Client Name is already shown). This reference can contain max 12 characters
+         */
+        BankWireRef: string;
+
+        /**
+         * Payment reference provided for the payout.
+         */
+        PaymentRef: PayoutPaymentRefData;
+
+        ModeRequested: PayoutModeRequestedType;
+
+        ModeApplied: PayoutModeAppliedType;
+
+        RecipientVerificationOfPayee?: VerificationOfPayee;
+    }
+
+    interface CreatePayOut {
+        /**
+         * A user's ID
+         */
+        AuthorId: 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;
+
+        /**
+         * An ID of a Bank Account
+         */
+        BankAccountId: string;
+
+        /**
+         * The ID of the wallet that was debited
+         */
+        DebitedWalletId: string;
+
+        /**
+         * A custom reference you wish to appear on the user’s bank statement (your Client Name is already shown). This reference can contain max 12 characters
+         */
+        BankWireRef?: string;
+
+        Tag?: string;
+
+        PaymentType: enums.IPayOutPaymentType["BankWire"];
+
+        /**
+         * Payout mode requested. May take one of the following values:
+         * STANDARD (value by default if no parameter is sent): a standard bank wire is requested and the processing time of the funds is about 48 hours;
+         * INSTANT_PAYMENT: an instant payment bank wire is requested and the processing time is within 25 seconds (subject to prerequisites)
+         * INSTANT_PAYMENT_ONLY: an instant payment bank wire is requested and the processing time is within 25 seconds,
+         * but if any prerequisite is not met or another problem occurs, there is no fallback: the wallet is automatically refunded and the payout is not completed.
+         */
+        PayoutModeRequested?: PayoutModeRequestedType;
+    }
+
+    interface CheckPayOutEligibility {
+        /**
+         * A user's ID
+         */
+        AuthorId: 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;
+
+        /**
+         * An ID of a Bank Account
+         */
+        BankAccountId: string;
+
+        /**
+         * The ID of the wallet that was debited
+         */
+        DebitedWalletId: string;
+
+        /**
+         * A custom reference you wish to appear on the user’s bank statement (your Client Name is already shown). This reference can contain max 12 characters
+         */
+        BankWireRef?: string;
+
+        /**
+         * Payout mode requested. May take one of the following values:
+         * STANDARD (value by default if no parameter is sent): a standard bank wire is requested and the processing time of the funds is about 48 hours;
+         * INSTANT_PAYMENT: an instant payment bank wire is requested and the processing time is within 25 seconds (subject to prerequisites)
+         * INSTANT_PAYMENT_ONLY: an instant payment bank wire is requested and the processing time is within 25 seconds,
+         * but if any prerequisite is not met or another problem occurs, there is no fallback: the wallet is automatically refunded and the payout is not completed.
+         */
+        PayoutModeRequested: PayoutModeRequestedType;
+
+        PaymentType: enums.IPayOutPaymentType["BankWire"];
+    }
+
+    interface CheckPayOutEligibilityData {
+        InstantPayout: InstantPayOutEligibilityData;
+    }
+
+    interface InstantPayOutEligibilityData {
+        IsReachable: boolean;
+
+        UnreachableReason?: FallbackReasonData;
+    }
+}

package/typings/models/recipient.d.ts

@@ -0,0 +1,242 @@
+import {CountryISO, CurrencyISO} from "../types";
+import { entityBase } from "./entityBase";
+import { address } from "./address";
+import { user } from "./user";
+
+export namespace recipient {
+    interface RecipientData extends entityBase.EntityBaseData {
+        /**
+         * The status
+         */
+        Status: string;
+
+        /**
+         * A unique external identifier for the recipient's bank account.
+         */
+        DisplayName: string;
+
+        /**
+         * Defines the payout method (e.g., LocalBankTransfer, InternationalBankTransfer).
+         */
+        PayoutMethodType: string;
+
+        /**
+         * Specifies whether the recipient is an Individual or a Business.
+         */
+        RecipientType: string;
+
+        /**
+         * 3-letter ISO 4217 destination currency code (e.g. EUR, USD, GBP, AUD, CAD,HKD, SGD, MXN).
+         */
+        Currency: CurrencyISO;
+
+        /**
+         * Country ISO
+         */
+        Country: CountryISO;
+
+        /**
+         * The scope of the recipient:
+         *
+         * <p>- PAYOUT – Usable for payouts and in pay-in use cases.
+         * A PAYOUT recipient can only be created by a user with the UserCategory OWNER and requires SCA.
+         * You need to use the returned PendingUserAction.RedirectUrl value, adding your encoded returnUrl as a
+         * query parameter, to redirect the user to the hosted SCA session so they can complete the necessary steps.</p>
+         *
+         * <p>- PAYIN - Usable for pay-in use cases only, such as direct debit and refunds using payouts.
+         * A PAYIN recipient can be created by a user with the UserCategory PAYER or OWNER, and does not require SCA.</p>
+         */
+        RecipientScope: string;
+
+        /**
+         * The unique identifier of the user.
+         */
+        UserId: string;
+
+        /**
+         * Individual recipient
+         */
+        IndividualRecipient: IndividualRecipientData;
+
+        /**
+         * Business recipient
+         */
+        BusinessRecipient: BusinessRecipientData;
+
+        /**
+         * The account details if PayoutMethodType is LocalBankTransfer, depending on the Currency.
+         */
+        LocalBankTransfer: any;
+
+        /**
+         * The account details if PayoutMethodType is InternationalBankTransfer.
+         */
+        InternationalBankTransfer: any;
+
+        /**
+         * Information about the action required from the user
+         */
+        PendingUserAction: user.PendingUserActionData;
+
+        RecipientVerificationOfPayee?: VerificationOfPayee;
+    }
+
+    interface CreateRecipientData {
+        /**
+         * A unique external identifier for the recipient's bank account.
+         */
+        DisplayName: string;
+
+        /**
+         * Defines the payout method (e.g., LocalBankTransfer, InternationalBankTransfer).
+         */
+        PayoutMethodType: string;
+
+        /**
+         * Specifies whether the recipient is an Individual or a Business.
+         */
+        RecipientType: string;
+
+        /**
+         * 3-letter ISO 4217 destination currency code (e.g. EUR, USD, GBP, AUD, CAD,HKD, SGD, MXN).
+         */
+        Currency: CurrencyISO;
+
+        /**
+         * Country ISO
+         */
+        Country?: CountryISO;
+
+        /**
+         * The scope of the recipient:
+         *
+         * <p>- PAYOUT – Usable for payouts and in pay-in use cases.
+         * A PAYOUT recipient can only be created by a user with the UserCategory OWNER and requires SCA.
+         * You need to use the returned PendingUserAction.RedirectUrl value, adding your encoded returnUrl as a
+         * query parameter, to redirect the user to the hosted SCA session so they can complete the necessary steps.</p>
+         *
+         * <p>- PAYIN - Usable for pay-in use cases only, such as direct debit and refunds using payouts.
+         * A PAYIN recipient can be created by a user with the UserCategory PAYER or OWNER, and does not require SCA.</p>
+         */
+        RecipientScope?: string;
+
+        /**
+         * Custom data that you can add to this object. This value cannot be changed once the recipient is created.
+         */
+        Tag?: string;
+
+        /**
+         * Individual recipient. Needed if BusinessRecipient is undefined
+         */
+        IndividualRecipient?: CreateIndividualRecipientData;
+
+        /**
+         * Business recipient. Needed if IndividualRecipient is undefined
+         */
+        BusinessRecipient?: CreateBusinessRecipientData;
+
+        /**
+         * The account details if PayoutMethodType is LocalBankTransfer, depending on the Currency.
+         * Needed if InternationalBankTransfer is undefined
+         */
+        LocalBankTransfer?: Record<string, any>;
+
+        /**
+         * The account details if PayoutMethodType is InternationalBankTransfer.
+         * Needed if LocalBankTransfer is undefined
+         */
+        InternationalBankTransfer?: Record<string, any>;
+
+        /**
+         * If provided, possible values: USER_PRESENT, USER_NOT_PRESENT
+         */
+        ScaContext?: string;
+    }
+
+    interface IndividualRecipientData {
+        FirstName: string;
+        LastName: string;
+        Address: address.AddressData;
+    }
+
+    interface CreateIndividualRecipientData {
+        FirstName: string;
+        LastName: string;
+        Address: address.CreateAddress;
+    }
+
+    interface BusinessRecipientData {
+        BusinessName: string;
+        Address: address.AddressData;
+    }
+
+    interface CreateBusinessRecipientData {
+        BusinessName: string;
+        Address: address.CreateAddress;
+    }
+
+    interface RecipientSchemaData {
+        DisplayName: RecipientPropertySchema;
+        Currency: RecipientPropertySchema;
+        Country: RecipientPropertySchema;
+        RecipientType: RecipientPropertySchema;
+        PayoutMethodType: RecipientPropertySchema;
+        RecipientScope: RecipientPropertySchema;
+        Tag: RecipientPropertySchema;
+        LocalBankTransfer: Record<string, Record<string, RecipientPropertySchema>>;
+        InternationalBankTransfer: Record<string, RecipientPropertySchema>;
+        IndividualRecipient: IndividualRecipientPropertySchema;
+        BusinessRecipient: BusinessRecipientPropertySchema;
+    }
+
+    interface RecipientPropertySchema {
+        Required: boolean;
+        MaxLength: number;
+        MinLength: number;
+        Pattern: string;
+        AllowedValues: string[];
+        Label: string;
+        EndUserDisplay: string;
+    }
+
+    interface RecipientAddressPropertySchema {
+        AddressLine1: RecipientPropertySchema;
+        AddressLine2: RecipientPropertySchema;
+        City: RecipientPropertySchema;
+        Region: RecipientPropertySchema;
+        PostalCode: RecipientPropertySchema;
+        Country: RecipientPropertySchema;
+    }
+
+    interface IndividualRecipientPropertySchema {
+        FirstName: RecipientPropertySchema;
+        LastName: RecipientPropertySchema;
+        Address: RecipientAddressPropertySchema;
+    }
+
+    interface BusinessRecipientPropertySchema {
+        BusinessName: RecipientPropertySchema;
+        Address: RecipientAddressPropertySchema;
+    }
+
+    interface PayoutMethodData extends entityBase.EntityBaseData {
+        AvailablePayoutMethods: string[]
+    }
+
+    interface VerificationOfPayee {
+        /**
+         * A unique identifier of the VOP check performed by Mangopay.
+         */
+        RecipientVerificationId?: string;
+
+        /**
+         * The outcome of the VOP check performed by Mangopay
+         */
+        RecipientVerificationCheck: string;
+
+        /**
+         * The explanation of the check outcome
+         */
+        RecipientVerificationMessage: string;
+    }
+}

package/typings/models/refund.d.ts

@@ -0,0 +1,92 @@
+import { transaction } from "./transaction";
+import { money } from "./money";
+
+export namespace refund {
+    import MoneyData = money.MoneyData;
+
+    type RefundReasonType =
+        | "INITIALIZED_BY_CLIENT"
+        | "BANKACCOUNT_INCORRECT"
+        | "OWNER_DO_NOT_MATCH_BANKACCOUNT"
+        | "BANKACCOUNT_HAS_BEEN_CLOSED"
+        | "WITHDRAWAL_IMPOSSIBLE_ON_SAVINGS_ACCOUNTS"
+        | "OTHER"
+        | "INITIALIZED_BY_MANGOPAY"
+        | "AG01_FORBIDDEN_TRANSACTION"
+        | "AC06_BLOCKED_BANKACCOUNT"
+        | "AG02_INVALID_BANK_OPERATION"
+        | "AM05_DUPLICATE_PAYMENT"
+        | "BE04_BENEFICIARY_ADDRESS_MISSING"
+        | "CNOR_INVALID_BIC"
+        | "ERIN_REMITTANCE_INFO_NOT_SUPPORTED"
+        | "MD07_BENEFICIARY_IS_DECEASED"
+        | "MS02_BENEFICIARY_ORDER"
+        | "MS03_NOT_SPECIFIED"
+        | "RC01_INVALIDE_BIC"
+        | "RR01_REGULATORY_REASON"
+        | "RR02_REGULATORY_REASON"
+        | "RR03_BENEFICIARY_NAME_OR_ADDRESS_MISSING"
+        | "RR04_REGULATORY_REASON"
+        | "ED05_SETTLEMENT_FAILED"
+        | "FF01_INVALID_FILE_FORMAT"
+        | "TM01_CUT_OFF_TIME"
+        | "DNOR_DEBTOR_BANK_NOT_REGISTERED"
+        | "FOCR_RECALLED"
+        | "CB";
+
+    interface RefundReason {
+        RefundReasonType: RefundReasonType;
+    }
+
+    interface RefundData extends transaction.TransactionData {
+        /**
+         * The nature of the transaction
+         */
+        Nature: "REFUND";
+
+        /**
+         * The initial transaction ID
+         */
+        InitialTransactionId: string;
+
+        /**
+         * The initial transaction type
+         */
+        InitialTransactionType: transaction.TransactionType;
+
+        /**
+         * Contains info about the reason for refund
+         */
+        RefundReason: RefundReason;
+
+        /**
+         * Custom description to appear on the user’s bank statement along with the platform name
+         */
+        StatementDescriptor: string;
+    }
+
+    interface CreatePayInRefund {
+        AuthorId: string;
+
+        Tag?: string;
+
+        DebitedFunds?: MoneyData;
+
+        Fees?: MoneyData;
+
+        /**
+         * Custom description to appear on the user’s bank statement along with the platform name
+         */
+        StatementDescriptor?: string; 
+    }
+
+    interface CreateTransferRefund {
+        AuthorId: string;
+
+        Tag?: string;
+
+        DebitedFunds?: MoneyData;
+
+        Fees?: MoneyData;
+    }
+}

package/typings/models/report.d.ts

@@ -0,0 +1,234 @@
+import { CurrencyISO, PickPartial, Timestamp } from "../types";
+import { transaction } from "./transaction";
+import { entityBase } from "./entityBase";
+
+export namespace report {
+    type Column =
+        | "Alias"
+        | "AuthorId"
+        | "BankAccountId"
+        | "BankWireRef"
+        | "CardId"
+        | "CardType"
+        | "Country"
+        | "CreationDate"
+        | "CreditedFundsAmount"
+        | "CreditedFundsCurrency"
+        | "CreditedUserId"
+        | "CreditedWalletId"
+        | "Culture"
+        | "DebitedFundsAmount"
+        | "DebitedFundsCurrency"
+        | "DebitedWalletId"
+        | "DeclaredDebitedFundsAmount"
+        | "DeclaredDebitedFundsCurrency"
+        | "DeclaredFeesAmount"
+        | "DeclaredFeesCurrency"
+        | "ExecutionDate"
+        | "ExecutionType"
+        | "ExpirationDate"
+        | "FeesAmount"
+        | "FeesCurrency"
+        | "Id"
+        | "Nature"
+        | "PaymentType"
+        | "PreauthorizationId"
+        | "ResultCode"
+        | "ResultMessage"
+        | "Status"
+        | "Tag"
+        | "Type"
+        | "WireReference"
+        | "Owners"
+        | "Description"
+        | "BalanceAmount"
+        | "BalanceCurrency"
+        | "Currency"
+        | "FundsType";
+
+    interface Filters {
+        /**
+         * To return only resources that have CreationDate BEFORE this date
+         */
+        BeforeDate: Timestamp;
+
+        /**
+         * To return only resources that have CreationDate AFTER this date
+         */
+        AfterDate: Timestamp;
+
+        /**
+         * The type of the transaction
+         */
+        Type: transaction.TransactionType[];
+
+        /**
+         * The status of the transaction
+         */
+        Status: transaction.TransactionStatus[];
+
+        /**
+         * The nature of the transaction
+         */
+        Nature: transaction.TransactionNature[];
+
+        /**
+         * The minimum amount of DebitedFunds
+         */
+        MinDebitedFundsAmount: number;
+
+        /**
+         * The currency for the minimum amount of DebitedFunds
+         */
+        MinDebitedFundsCurrency: CurrencyISO;
+
+        /**
+         * The maximum amount of DebitedFunds
+         */
+        MaxDebitedFundsAmount: number;
+
+        /**
+         * The currency for the maximum amount of DebitedFunds
+         */
+        MaxDebitedFundsCurrency: CurrencyISO;
+
+        /**
+         * The minimum amount of Fees
+         */
+        MinFeesAmount: number;
+
+        /**
+         * The currency for the minimum amount of Fees
+         */
+        MinFeesCurrency: CurrencyISO;
+
+        /**
+         * The maximum amount of Fees
+         */
+        MaxFeesAmount: number;
+
+        /**
+         * The currency for the maximum amount of Fees
+         */
+        MaxFeesCurrency: CurrencyISO;
+
+        /**
+         * A user's ID
+         */
+        AuthorId: string;
+
+        /**
+         * The ID of a wallet
+         */
+        WalletId: string;
+
+        /**
+         * The transaction result codes to be taken into account.
+         */
+        ResultCode?: string[];
+
+        /**
+         * The unique identifier of the user owning the wallet.
+         */
+        OwnerId?: string;
+
+        /**
+         * The currency of the wallets to take into account.
+         */
+        Currency?: string;
+
+        /**
+         * The balance amount above which the wallets are taken into account.
+         */
+        MinBalanceAmount?: number;
+
+        /**
+         * The currency of the MinBalanceAmount value.
+         */
+        MinBalanceCurrency?: CurrencyISO;
+
+        /**
+         * The balance amount below which the wallets are taken into account.
+         */
+        MaxBalanceAmount?: number;
+
+        /**
+         * The currency of the MaxBalanceAmount value.
+         */
+        MaxBalanceCurrency?: CurrencyISO;
+    }
+
+    interface ReportData extends entityBase.EntityBaseData {
+        /**
+         * The date when the report was executed
+         */
+        ReportDate: Timestamp;
+
+        /**
+         * The URL to download the report
+         */
+        DownloadURL: string;
+
+        /**
+         * A URL that we will ping when the report is ready to download(works in a similar way to the hooks)
+         */
+        CallbackURL: string;
+
+        /**
+         * The format of the report download
+         */
+        DownloadFormat: "CSV";
+
+        /**
+         * The type of report
+         */
+        ReportType: "TRANSACTIONS" | "WALLETS";
+
+        /**
+         * The column to sort against and direction separated by a `:`
+         */
+        Sort: string;
+
+        /**
+         * Whether the report should be limited to the first 10 lines(and therefore quicker to execute)
+         */
+        Preview: boolean;
+
+        /**
+         * An object of various filters for the report
+         */
+        Filters: Filters;
+
+        /**
+         * A list of columns / infos to show in the report
+         */
+        Columns: Column[];
+
+        /**
+         * The result code
+         */
+        ResultCode: string;
+
+        /**
+         * A verbal explanation of the ResultCode
+         */
+        ResultMessage: string;
+
+        /**
+         * The status of the report.
+         * Returned values: PENDING, READY_FOR_DOWNLOAD, FAILED, EXPIRED
+         */
+        Status: string;
+    }
+
+    interface CreateReport extends PickPartial<ReportData,
+        | "Tag"
+        | "CallbackURL"
+        | "DownloadFormat"
+        | "Sort"
+        | "Preview"
+        | "Filters"
+        | "Columns"
+        | "ReportType"> {
+    }
+}