mangopay4-nodejs-sdk 1.64.0

package/typings/models/cardPreauthorization.d.ts

@@ -0,0 +1,157 @@
+import { CountryISO, PickPartialRequired, SecureMode, Timestamp } from "../types";
+import { entityBase } from "./entityBase";
+import { billing } from "./billing";
+import { base } from "../base";
+import { money } from "./money";
+import { securityInfo } from "./securityInfo";
+import { shipping } from "./shipping";
+import { card } from "./card";
+
+export namespace cardPreAuthorization {
+    import BillingData = billing.BillingData;
+    import BrowserInfoData = base.BrowserInfoData;
+    import MoneyData = money.MoneyData;
+    import SecurityInfoData = securityInfo.SecurityInfoData;
+    import ShippingData = shipping.ShippingData;
+    import CardInfoData = card.CardInfoData;
+
+    type PreAuthorizationExecutionType = "DIRECT";
+
+    type PaymentStatus = "WAITING" | "CANCELED" | "EXPIRED" | "VALIDATED";
+
+    type PreAuthorizationStatus = "CREATED" | "SUCCEEDED" | "FAILED";
+
+    type CreateCardPreAuthorization = PickPartialRequired<CardPreAuthorizationData,
+        "Tag" | "Billing" | "SecureMode" | "Culture" | "StatementDescriptor" | "Shipping" | "PaymentCategory", "AuthorId" | "DebitedFunds" | "CardId" | "SecureModeReturnURL" | "IpAddress" | "BrowserInfo">;
+
+    type UpdateCardPreAuthorization = PickPartialRequired<CardPreAuthorizationData,
+        "Tag",
+        "PaymentStatus" | "Id">;
+
+    interface CardPreAuthorizationData extends entityBase.EntityBaseData {
+        /**
+         * A user's ID
+         */
+        AuthorId: string;
+
+        /**
+         * Information about the funds that are being debited
+         */
+        DebitedFunds: MoneyData;
+
+        /**
+         * Value of the funds remaining on a pre-authorization
+         */
+        RemainingFunds: MoneyData;
+
+        /**
+         * Status of the PreAuthorization
+         */
+        Status: PreAuthorizationStatus;
+
+        /**
+         * The status of the payment after the PreAuthorization. You can pass the PaymentStatus from "WAITING" to "CANCELED" should you need/want to
+         */
+        PaymentStatus: PaymentStatus;
+
+        /**
+         * The result code
+         */
+        ResultCode: string;
+
+        /**
+         * A verbal explanation of the ResultCode
+         */
+        ResultMessage: string;
+
+        /**
+         * How the PreAuthorization has been executed
+         */
+        ExecutionType: PreAuthorizationExecutionType;
+
+        /**
+         * The SecureMode corresponds to '3D secure' for CB Visa and MasterCard. This field lets you activate it manually.
+         * The field lets you activate it automatically with "DEFAULT" (Secured Mode will be activated from €50 or when MANGOPAY detects there is a higher risk ),
+         * "FORCE" (if you wish to specifically force the secured mode).
+         */
+        SecureMode: SecureMode;
+
+        /**
+         * The language to use for the payment page - needs to be the ISO code of the language
+         */
+        Culture: CountryISO;
+
+        /**
+         * The ID of a card
+         */
+        CardId: string;
+
+        /**
+         * The value is 'true' if the SecureMode was used
+         */
+        SecureModeNeeded: boolean;
+
+        /**
+         * This is the URL where to redirect users to proceed to 3D secure validation
+         */
+        SecureModeRedirectURL: string;
+
+        /**
+         * This is the URL where users are automatically redirected after 3D secure validation (if activated)
+         */
+        SecureModeReturnURL: string;
+
+        /**
+         * A custom description to appear on the user's bank statement.
+         * It can be up to 10 characters long, and can only include alphanumeric characters or spaces.
+         * See here for important info. Note that each bank handles this information differently, some show less or no information.
+         */
+        StatementDescriptor: string;
+
+        /**
+         * The date when the payment is to be processed by
+         */
+        ExpirationDate: Timestamp;
+
+        /**
+         * The Id of the associated PayIn
+         */
+        PayInId: string;
+
+        /**
+         * Contains useful information related to the user billing
+         */
+        Billing: BillingData;
+
+        /**
+         * Contains useful information related to security and fraud
+         */
+        SecurityInfo: SecurityInfoData;
+
+        /**
+         * IP Address of the end user (format IPV4 or IPV6)
+         */
+        IpAddress: string;
+
+        /**
+         * This object describes the Browser being user by an end user
+         */
+        BrowserInfo: BrowserInfoData;
+
+        /**
+         * Contains every useful information's related to the user shipping
+         */
+        Shipping: ShippingData;
+
+        CardInfo: CardInfoData;
+
+        /**
+         * The channel through which the user provided their card details, used to indicate mail-order and telephone-order (MOTO) payments:
+         *
+         * ECommerce – Payment received online.
+         *
+         * TelephoneOrder – Payment received via mail order or telephone order (MOTO).
+         */
+        PaymentCategory: string;
+    }
+}

package/typings/models/cardRegistration.d.ts

@@ -0,0 +1,83 @@
+import { CurrencyISO, PickPartial, PickPartialRequired } from "../types";
+import { card } from "./card";
+import { entityBase } from "./entityBase";
+
+export namespace cardRegistration {
+    type UpdateCardRegistration = {
+        /**
+         * The unique identifier of the Card Registration object.
+         */
+        Id: string;
+
+        /**
+         * The string returned by the tokenization server after the Tokenize the card call is made.
+         */
+        RegistrationData: string;
+
+        /**
+         * The cardholder’s name shown on the payment card
+         */
+        CardHolderName?: string;
+    }
+
+    interface CardRegistrationData extends entityBase.EntityBaseData {
+        /**
+         * The object owner's UserId
+         */
+        UserId: string;
+        /**
+         * The currency - should be ISO_4217 format
+         */
+        Currency: CurrencyISO;
+
+        /**
+         * A special key to use when registering a card
+         */
+        AccessKey: string;
+
+        /**
+         * A specific value to pass to the CardRegistrationURL
+         */
+        PreregistrationData: string;
+
+        /**
+         * The URL to submit the card details form to
+         */
+        CardRegistrationURL: string;
+
+        /**
+         * Having registered a card, this confirmation hash needs to be updated to the card item
+         */
+        RegistrationData: string;
+
+        /**
+         * The type of card
+         */
+        CardType: card.CardType;
+
+        /**
+         * The ID of a card
+         */
+        CardId: string;
+
+        /**
+         * The result code
+         */
+        ResultCode: string;
+
+        /**
+         * A verbal explanation of the ResultCode
+         */
+        ResultMessage: string;
+
+        /**
+         * Status of the card registration
+         */
+        Status: card.CardStatus;
+    }
+
+    interface CreateCardRegistration extends PickPartialRequired<CardRegistrationData,
+        "CardType" | "Tag",
+        "UserId" | "Currency"> {
+    }
+}

package/typings/models/cardValidation.d.ts

@@ -0,0 +1,125 @@
+import { card } from "./card";
+import { entityBase } from "./entityBase";
+import { transaction } from "./transaction";
+import { base } from "../base";
+import { payIn } from "./payIn";
+import { SecureMode } from "../types";
+
+export namespace cardValidation {
+    interface CardValidationData extends entityBase.EntityBaseData {
+        /**
+         * The unique identifier of the user at the source of the transaction.
+         */
+        AuthorId: string;
+
+        /**
+         * The status of the transaction.
+         */
+        Status: transaction.TransactionStatus;
+
+        /**
+         * The URL to which users are automatically returned after 3DS2 if it is triggered (i.e., if the SecureModeNeeded parameter is set to true).
+         */
+        SecureModeReturnURL: string;
+
+        /**
+         * The URL to which users are to be redirected to proceed to 3DS2 validation.
+         */
+        SecureModeRedirectURL: string;
+
+        /**
+         * Whether or not the SecureMode was used.
+         */
+        SecureModeNeeded: boolean;
+
+        /**
+         * The mode applied for the 3DS2 protocol for CB, Visa, and Mastercard
+         */
+        SecureMode: SecureMode;
+
+        /**
+         * The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.
+         */
+        IpAddress: string;
+
+        /**
+         * Information about the browser used by the end user (author) to perform the payment.
+         */
+        BrowserInfo: base.BrowserInfoData;
+
+        /**
+         * Whether the card is valid or not.
+         */
+        Validity: card.CardValidity;
+
+        /**
+         * The type of transaction. In the specific case of the Card Validation object, this value indicates a transaction made to perform a strong customer authentication without debiting the card.
+         */
+        Type: transaction.TransactionType;
+
+        /**
+         * The 3DS protocol version applied to the transaction.
+         */
+        Applied3DSVersion: payIn._3DSVersion;
+
+        /**
+         * 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 channel through which the user provided their card details, used to indicate mail-order and telephone-order (MOTO) payments:
+         *
+         * ECommerce – Payment received online.
+         *
+         * TelephoneOrder – Payment received via mail order or telephone order (MOTO).
+         */
+        PaymentCategory: string;
+    }
+
+    interface CreateCardValidation {
+        /**
+         * The unique identifier of the user at the source of the transaction.
+         */
+        AuthorId: string;
+
+        /**
+         * The URL to which users are automatically returned after 3DS2 if it is triggered (i.e., if the SecureModeNeeded parameter is set to true).
+         */
+        SecureModeReturnURL: string;
+
+        /**
+         * The mode applied for the 3DS2 protocol for CB, Visa, and Mastercard
+         */
+        SecureMode?: SecureMode;
+
+        /**
+         * The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.
+         */
+        IpAddress: string;
+
+        /**
+         * Information about the browser used by the end user (author) to perform the payment.
+         */
+        BrowserInfo: base.BrowserInfoData;
+
+        /**
+         * Custom data that you can add to this object.
+         */
+        Tag?: string;
+
+        /**
+         * The channel through which the user provided their card details, used to indicate mail-order and telephone-order (MOTO) payments:
+         *
+         * ECommerce – Payment received online.
+         *
+         * TelephoneOrder – Payment received via mail order or telephone order (MOTO).
+         */
+        PaymentCategory?: string;
+    }
+}

package/typings/models/client.d.ts

@@ -0,0 +1,208 @@
+import { ValueOf } from "../types";
+import { enums } from "../enums";
+import { address } from "./address";
+import { entityBase } from "./entityBase";
+import { money } from "./money";
+
+export namespace client {
+    import MoneyData = money.MoneyData;
+
+    type BusinessType = "MARKETPLACE" | "CROWDFUNDING" | "FRANCHISE" | "OTHER";
+
+    type Sector =
+        | "RENTALS"
+        | "STORES_FASHION_ACCESSORIES_OBJECTS"
+        | "BEAUTY_COSMETICS_HEALTH"
+        | "FOOD_WINE_RESTAURANTS"
+        | "HOSPITALITY_TRAVEL_CORIDING"
+        | "ART_MUSIC_ENTERTAINMENT"
+        | "FURNITURE_GARDEN"
+        | "SERVICES_JOBBING_EDUCATION"
+        | "SPORT_RECREATION_ACTIVITIES"
+        | "TICKETING"
+        | "LOAN"
+        | "EQUITY"
+        | "PROPERTY_EQUITY"
+        | "REWARDS_CHARITY"
+        | "POOL_GROUP_PAYMENT"
+        | "FRANCHISE_"
+        | "OTHER_";
+
+    type PlatformType = ValueOf<enums.IPlatformType>;
+
+    interface PlatformCategorization {
+        Sector: Sector;
+
+        BusinessType: BusinessType;
+    }
+
+    interface ClientData extends entityBase.EntityBaseData {
+        /**
+         * The pretty name for the client
+         */
+        Name: string;
+
+        /**
+         * The registered name of your company
+         */
+        RegisteredName: string;
+
+        /**
+         * An ID for the client (i.e. url friendly, lowercase etc - sort of namespace identifier)
+         */
+        ClientId: string;
+
+        /**
+         * The primary branding colour to use for your merchant
+         */
+        PrimaryThemeColour: string;
+
+        /**
+         * The primary branding colour to use for buttons for your merchant
+         */
+        PrimaryButtonColour: string;
+
+        /**
+         * The URL of the logo of your client
+         */
+        Logo: string;
+
+        /**
+         * A list of email addresses to use when contacting you for technical issues/communications
+         */
+        TechEmails: string[];
+
+        /**
+         * A list of email addresses to use when contacting you for admin/commercial issues/communications
+         */
+        AdminEmails: string[];
+
+        /**
+         * A list of email addresses to use when contacting you for fraud/compliance issues/communications
+         */
+        FraudEmails: string[];
+
+        /**
+         * A list of email addresses to use when contacting you for billing issues/communications
+         */
+        BillingEmails: string[];
+
+        /**
+         * The Categorization of your platform, in terms of Business Type and Sector
+         */
+        PlatformCategorization: PlatformCategorization;
+
+        /**
+         * A description of what your platform does
+         */
+        PlatformDescription: string;
+
+        /**
+         * The URL for your website
+         */
+        PlatformURL: string;
+
+        /**
+         * The address of the company’s headquarters
+         */
+        HeadquartersAddress: address.AddressType;
+
+        /**
+         * The phone number of the company's headquarters
+         */
+        HeadquartersPhoneNumber: string;
+
+        /**
+         * The tax (or VAT) number for your company
+         */
+        TaxNumber: string;
+
+        /**
+         * Your unique MANGOPAY reference which you should use when contacting us
+         */
+        CompanyReference: string;
+
+        /**
+         * The licensor of the platform’s company account, indicating the Mangopay entity the platform contracted with
+         */
+        Licensor: string;
+    }
+
+    interface UpdateClient {
+        /**
+         * The primary branding colour to use for buttons for your merchant
+         */
+        PrimaryButtonColour?: string;
+
+        /**
+         * The primary branding colour to use for your merchant
+         */
+        PrimaryThemeColour?: string;
+
+        /**
+         * A list of email addresses to use when contacting you for admin/commercial issues/communications
+         */
+        AdminEmails?: string[];
+
+        /**
+         * A list of email addresses to use when contacting you for technical issues/communications
+         */
+        TechEmails?: string[];
+
+        /**
+         * A list of email addresses to use when contacting you for billing issues/communications
+         */
+        BillingEmails?: string[];
+
+        /**
+         * A list of email addresses to use when contacting you for fraud/compliance issues/communications
+         */
+        FraudEmails?: string[];
+
+        /**
+         * The address of the company’s headquarters
+         */
+        HeadquartersAddress?: address.AddressType;
+
+        /**
+         * The tax (or VAT) number for your company
+         */
+        TaxNumber?: string;
+
+        /**
+         * The type of platform
+         */
+        PlatformType?: PlatformType;
+
+        /**
+         * A description of what your platform does
+         */
+        PlatformDescription?: string;
+
+        /**
+         * The URL for your website
+         */
+        PlatformURL?: string;
+    }
+
+    interface UpdateClientLogo {
+        /**
+         * The base64 encoded file which needs to be uploaded
+         */
+        File: string;
+    }
+
+    interface CreateBankWireDirectPayIn {
+        /**
+         * The unique identifier of the credited wallet.
+         * In the case of the direct bank wire to the Repudiation Wallet,
+         * this value has the format CREDIT_CCY where CCY is the currency of the Client Wallet to be credited (e.g., CREDIT_EUR).
+         */
+        CreditedWalletId: string;
+
+        /**
+         * Information about the declared funds to be wired by the platform to the returned bank account.
+         */
+        DeclaredDebitedFunds: MoneyData;
+    }
+}