mangopay4-nodejs-sdk 1.64.0

package/typings/models/conversion.d.ts

@@ -0,0 +1,225 @@
+import { entityBase } from "./entityBase";
+import { money } from "./money";
+import { transaction } from "./transaction";
+import { conversionRate } from "./conversionRate";
+
+export namespace conversion {
+    import TransactionStatus = transaction.TransactionStatus;
+    import TransactionType = transaction.TransactionType;
+    import TransactionNature = transaction.TransactionNature;
+    import MoneyData = money.MoneyData;
+    import MoneyDataOptionalAmount = money.MoneyDataOptionalAmount;
+    import ConversionRateData = conversionRate.ConversionRateData;
+
+    type QuoteStatus = "ACTIVE" | "EXPIRED";
+
+    interface ConversionData extends entityBase.EntityBaseData {
+        /**
+         * The unique identifier of the active quote which guaranteed the rate for the conversion.
+         */
+        QuoteId: string;
+
+        /**
+         * The unique identifier of the user at the source of the transaction
+         */
+        AuthorId: string;
+
+        /**
+         * The unique identifier of the debited wallet.
+         */
+        DebitedWalletId: string;
+
+        /**
+         * The unique identifier of the credited wallet
+         */
+        CreditedWalletId: string;
+
+        /**
+         * The sell funds
+         */
+        DebitedFunds: MoneyData;
+
+        /**
+         * The buy funds
+         */
+        CreditedFunds: MoneyData;
+
+        /**
+         * Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
+         * Note: The fees currency must match the debited funds currency.
+         */
+        Fees: MoneyData;
+
+        /**
+         * Real time indicative market rate of a specific currency pair
+         */
+        ConversionRateResponse: ConversionRateData;
+
+        /**
+         * The status of the transaction.
+         */
+        Status: TransactionStatus;
+
+        /**
+         * The type of transaction
+         */
+        Type: TransactionType;
+
+        /**
+         * The nature of the transaction, providing more
+         * information about the context in which the transaction occurred
+         */
+        Nature: TransactionNature;
+
+        /**
+         * The code indicates 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 date and time at which the status changed to SUCCEEDED,
+         * indicating that the transaction occurred.
+         * The statuses CREATED and FAILED return an ExecutionDate of null
+         */
+        ExecutionDate: number;
+    }
+
+    interface CreateInstantConversion {
+        /**
+         * The unique identifier of the user at the source of the transaction.
+         */
+        AuthorId: string;
+
+        /**
+         * The unique identifier of the debited wallet.
+         */
+        DebitedWalletId: string;
+
+        /**
+         * The unique identifier of the credited wallet
+         */
+        CreditedWalletId: string;
+
+        /**
+         * The sell funds
+         */
+        DebitedFunds: MoneyData;
+
+        /**
+         * The buy funds
+         */
+        CreditedFunds: MoneyData;
+
+        /**
+         * Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
+         * Note: The fees currency must match the debited funds currency.
+         */
+        Fees?: MoneyData;
+
+        /**
+         * Custom data that you can add to this object.
+         */
+        Tag?: string;
+    }
+
+    interface CreateQuotedConversion {
+        /**
+         * The unique identifier of the active quote which guaranteed the rate for the conversion.
+         */
+        QuoteId: string;
+
+        /**
+         * The unique identifier of the user at the source of the transaction.
+         */
+        AuthorId: string;
+
+        /**
+         * The unique identifier of the debited wallet.
+         */
+        DebitedWalletId: string;
+
+        /**
+         * The unique identifier of the credited wallet
+         */
+        CreditedWalletId: string;
+
+        /**
+         * Custom data that you can add to this object.
+         */
+        Tag?: string;
+    }
+
+    interface CreateClientWalletsQuotedConversion {
+        /**
+         * The unique identifier of the active quote which guaranteed the rate for the conversion.
+         */
+        QuoteId: string;
+
+        /**
+         * The type of the client wallet to be debited.
+         * Allowed values: FEES, CREDIT
+         */
+        DebitedWalletType: string;
+
+        /**
+         * The type of the client wallet to be credited.
+         * Allowed values: FEES, CREDIT
+         */
+        CreditedWalletType: string;
+
+        /**
+         * Custom data that you can add to this object.
+         */
+        Tag?: string;
+    }
+
+    interface CreateClientWalletsInstantConversion {
+        /**
+         * The sell funds
+         */
+        DebitedFunds: MoneyData;
+
+        /**
+         * The buy funds
+         */
+        CreditedFunds: MoneyDataOptionalAmount;
+
+        /**
+         * The type of the client wallet to be debited.
+         * Allowed values: FEES, CREDIT
+         */
+        DebitedWalletType: string;
+
+        /**
+         * The type of the client wallet to be credited.
+         * Allowed values: FEES, CREDIT
+         */
+        CreditedWalletType: string;
+
+        /**
+         * Custom data that you can add to this object.
+         */
+        Tag?: string;
+    }
+
+    interface QuoteData extends entityBase.EntityBaseData {
+        ExpirationDate: number;
+        Status: QuoteStatus;
+        DebitedFunds: MoneyData;
+        CreditedFunds: MoneyData;
+        ConversionRateResponse: ConversionRateData;
+    }
+
+    interface CreateQuote {
+        DebitedFunds: MoneyData;
+        CreditedFunds: MoneyData;
+        Duration: number;
+        Tag?: string;
+    }
+}

package/typings/models/conversionRate.d.ts

@@ -0,0 +1,29 @@
+export namespace conversionRate {
+    interface ConversionRateData {
+        /**
+         * The sell currency – the currency of the wallet to be debited
+         */
+        DebitedCurrency: string;
+
+        /**
+         * The buy currency – the currency of the wallet to be credited.
+         */
+        CreditedCurrency: string;
+
+        /**
+         * The market rate plus Mangopay's commission,
+         * charged during the platform's billing cycle. This is an indicative rate.
+         */
+        ClientRate: string;
+
+        /**
+         * The rate used for the conversion, excluding Mangopay's commission.
+         */
+        MarketRate: string;
+
+        /**
+         *
+         */
+        MarketRateDate: number;
+    }
+}

package/typings/models/countryAuthorization.d.ts

@@ -0,0 +1,16 @@
+import { CountryISO } from "../types";
+
+export namespace countryAuthorization {
+    interface AuthorizationData {
+        BlockUserCreation: boolean;
+        BlockBankAccountCreation: boolean;
+        BlockPayout: boolean;
+    }
+
+    interface CountryAuthorizationData {
+        CountryCode: CountryISO;
+        CountryName: string;
+        Authorization: AuthorizationData;
+        LastUpdate: number;
+    }
+}

package/typings/models/deposit.d.ts

@@ -0,0 +1,104 @@
+import { CountryISO, Timestamp, ValueOf } from "../types";
+import { entityBase } from "./entityBase";
+import { money } from "./money";
+import { enums } from "../enums";
+import { payIn } from "./payIn";
+import { base } from "../base";
+import { billing } from "./billing";
+import { shipping } from "./shipping";
+import { card } from "./card";
+
+export namespace deposit {
+    import MoneyData = money.MoneyData;
+    import PayInPaymentType = payIn.PayInPaymentType;
+    import PayInExecutionType = payIn.PayInExecutionType;
+    import BrowserInfoData = base.BrowserInfoData;
+    import ShippingData = shipping.ShippingData;
+    import CompleteBillingData = billing.CompleteBillingData;
+    import _3DSVersion = payIn._3DSVersion;
+    import CardInfoData = card.CardInfoData;
+
+    type DepositStatus = ValueOf<enums.IDepositStatus>;
+
+    type PaymentStatus = ValueOf<enums.IPaymentStatus>;
+
+    interface DepositData extends entityBase.EntityBaseData {
+        AuthorId: string;
+
+        DebitedFunds: MoneyData;
+
+        Status: DepositStatus;
+
+        PaymentStatus: PaymentStatus;
+
+        PayinsLinked: PayinsLinkedData;
+
+        ResultCode: string;
+
+        ResultMessage: string;
+
+        CardId: string;
+
+        SecureModeReturnURL: string;
+
+        SecureModeRedirectURL: string;
+
+        SecureModeNeeded: boolean;
+
+        ExpirationDate: Timestamp;
+
+        PaymentType: PayInPaymentType;
+
+        ExecutionType: PayInExecutionType;
+
+        StatementDescriptor: string;
+
+        Culture: CountryISO;
+
+        IpAddress: string;
+
+        BrowserInfo: BrowserInfoData;
+
+        Billing: CompleteBillingData;
+
+        Shipping: ShippingData;
+
+        Requested3DSVersion: _3DSVersion;
+
+        Applied3DSVersion: _3DSVersion;
+
+        CardInfo: CardInfoData;
+    }
+
+    interface CreateDeposit {
+        AuthorId: string;
+
+        DebitedFunds: MoneyData;
+
+        CardId: string;
+
+        SecureModeReturnURL: string;
+
+        StatementDescriptor?: string;
+
+        Culture?: CountryISO;
+
+        IpAddress: string;
+
+        BrowserInfo: BrowserInfoData;
+
+        Billing?: CompleteBillingData;
+
+        Shipping?: ShippingData;
+    }
+
+    interface PayinsLinkedData {
+        PayinCaptureId: string;
+        PayinComplementId: string;
+    }
+
+    interface UpdateDeposit {
+        Id: string;
+        PaymentStatus?: PaymentStatus;
+    }
+}

package/typings/models/dispute.d.ts

@@ -0,0 +1,116 @@
+import { transaction } from "./transaction";
+import { PickPartial, Timestamp } from "../types";
+import { entityBase } from "./entityBase";
+import { money } from "./money";
+
+export namespace dispute {
+    import MoneyData = money.MoneyData;
+
+    type DisputeReasonType =
+        | "DUPLICATE"
+        | "FRAUD"
+        | "PRODUCT_UNACCEPTABLE"
+        | "UNKNOWN"
+        | "OTHER"
+        | "REFUND_CONVERSION_RATE"
+        | "LATE_FAILURE_INSUFFICIENT_FUNDS"
+        | "LATE_FAILURE_CONTACT_USER"
+        | "LATE_FAILURE_BANKACCOUNT_CLOSED"
+        | "LATE_FAILURE_BANKACCOUNT_INCOMPATIBLE"
+        | "LATE_FAILURE_BANKACCOUNT_INCORRECT"
+        | "AUTHORISATION_DISPUTED"
+        | "TRANSACTION_NOT_RECOGNIZED"
+        | "PRODUCT_NOT_PROVIDED"
+        | "CANCELED_REOCCURING_TRANSACTION"
+        | "REFUND_NOT_PROCESSED";
+
+    type DisputeStatus =
+        | "CREATED"
+        | "PENDING_CLIENT_ACTION"
+        | "SUBMITTED"
+        | "PENDING_BANK_ACTION"
+        | "REOPENED_PENDING_CLIENT_ACTION"
+        | "CLOSED";
+
+    type DisputeType = "CONTESTABLE" | "NOT_CONTESTABLE" | "RETRIEVAL";
+
+    interface DisputeReason {
+        DisputeReasonType: DisputeReasonType;
+
+        DisputeReasonMessage: string;
+    }
+
+    interface DisputeData extends entityBase.EntityBaseData {
+        /**
+         * The initial transaction ID
+         */
+        InitialTransactionId: string;
+
+        /**
+         * The initial transaction type
+         */
+        InitialTransactionType: transaction.TransactionType;
+
+        /**
+         * The result code
+         */
+        ResultCode: string;
+
+        /**
+         * A verbal explanation of the ResultCode
+         */
+        ResultMessage: string;
+
+        /**
+         * Info about the reason for the dispute
+         */
+        DisputeReason: DisputeReason;
+
+        /**
+         * The status of the dispute
+         */
+        Status: DisputeStatus;
+
+        /**
+         * Used to communicate information about the dispute status to you
+         */
+        StatusMessage: string;
+
+        /**
+         * The amount of funds that were disputed
+         */
+        DisputedFunds: MoneyData;
+
+        /**
+         * The amount you wish to contest
+         */
+        ContestedFunds: MoneyData;
+
+        /**
+         * The type of dispute
+         */
+        DisputeType: DisputeType;
+
+        /**
+         * The deadline by which you must contest the dispute (if you wish to contest it)
+         */
+        ContestDeadlineDate: Timestamp;
+
+        /**
+         * The date and time the dispute was closed
+         */
+        ClosedDate: Timestamp;
+
+        /**
+         * The ID of the associated repudiation transaction
+         */
+        RepudiationId: string;
+    }
+
+    interface SubmitDispute
+        extends PickPartial<DisputeData, "ContestedFunds"> {
+    }
+
+    interface UpdateDispute extends PickPartial<DisputeData, "Tag"> {
+    }
+}

package/typings/models/disputeDocument.d.ts

@@ -0,0 +1,119 @@
+import { Timestamp } from "../types";
+import { entityBase } from "./entityBase";
+
+export namespace disputeDocument {
+    type DisputeDocumentType =
+        | "DELIVERY_PROOF"
+        | "INVOICE"
+        | "REFUND_PROOF"
+        | "USER_CORRESPONDANCE"
+        | "USER_ACCEPTANCE_PROOF"
+        | "PRODUCT_REPLACEMENT_PROOF"
+        | "OTHER";
+
+    type DocumentStatus =
+        | "CREATED"
+        | "VALIDATION_ASKED"
+        | "VALIDATED"
+        | "REFUSED"
+        | "OUT_OF_DATE";
+
+    type RefusedReasonType =
+        | "DOCUMENT_UNREADABLE"
+        | "DOCUMENT_NOT_ACCEPTED"
+        | "DOCUMENT_HAS_EXPIRED"
+        | "DOCUMENT_INCOMPLETE"
+        | "DOCUMENT_MISSING"
+        | "SPECIFIC_CASE"
+        | "DOCUMENT_FALSIFIED"
+        | "OTHER";
+
+    interface DisputeDocumentData extends entityBase.EntityBaseData {
+        /**
+         * Gives the type of the KYC document
+         */
+        Type: DisputeDocumentType;
+
+        /**
+         * The object owner's UserId
+         */
+        UserId: string;
+
+        /**
+         * The Id of a Dispute
+         */
+        DisputeId: string;
+
+        /**
+         * The status of this KYC/Dispute document
+         */
+        Status: DocumentStatus;
+
+        /**
+         * The message accompanying a refusal
+         */
+        RefusedReasonMessage: string;
+
+        /**
+         * The type of reason for refusal
+         */
+        RefusedReasonType: RefusedReasonType;
+
+        /**
+         * The date when the document was processed by MANGOPAY
+         */
+        ProcessedDate: Timestamp;
+    }
+
+    interface CreateDisputeDocument {
+        /**
+         * Gives the type of the KYC document
+         */
+        Type: DisputeDocumentType;
+        Tag?: string;
+    }
+
+    interface SubmitDisputeDocument {
+        /**
+         * The status of this KYC/Dispute document
+         */
+        Status: "VALIDATION_ASKED";
+        Tag?: string;
+    }
+
+    /**
+     * - Documents have to be in "CREATED" Status
+     * - You can create as many pages as needed
+     *
+     * Remember to change Status to "VALIDATION_ASKED" to submit KYC documents
+     * The maximum size per page is about 7Mb (or 10Mb when base64encoded). The following formats are accepted for the documents : .pdf, .jpeg, .jpg, .gif and .png. The minimum size is 1Kb.
+     */
+    interface CreateDisputeDocumentPage {
+        /**
+         * The base64 encoded file which needs to be uploaded
+         *
+         * You need to fill in only the binary code. Do not send the first part that some converters add into the binary code which is
+         * `<img src=" data:image/png;base64..." />`
+         *
+         * e.g.
+         * ```json
+         * {
+         *   "File": "/9j/4AAQSkZJRgABAQEBLAEsAAD/.../wgARCAAyADIDAREAAhEBAxEB/8QAGwAAAgMBAQEA"
+         * }
+         * ```
+         */
+        File: string;
+    }
+
+    interface DocumentPageConsult {
+        /**
+         * URL where this document page can be viewed.
+         */
+        Url: string;
+
+        /**
+         * Time in millis when the page consult will expire.
+         */
+        ExpirationDate: Timestamp;
+    }
+}

package/typings/models/entityBase.d.ts

@@ -0,0 +1,9 @@
+export namespace entityBase {
+    interface EntityBaseData {
+        Id: string;
+
+        Tag: string;
+
+        CreationDate: number;
+    }
+}