mangopay4-nodejs-sdk 1.64.0

package/typings/models/address.d.ts

@@ -0,0 +1,70 @@
+import { CountryISO } from "../types";
+import { Models } from "../models";
+
+export namespace address {
+    type AddressType = string | AddressData | Models.Address | CreateAddress;
+
+    interface AddressData {
+        /**
+         * The first line of the address
+         */
+        AddressLine1: string;
+
+        /**
+         * The second line of the address
+         */
+        AddressLine2?: string;
+
+        /**
+         * The city of the address
+         */
+        City: string;
+
+        /**
+         * The region of the address - this is optional except if the Country is US, CA or MX
+         */
+        Region?: string;
+
+        /**
+         * The postal code of the address - can be alphanumeric, dashes or spaces
+         */
+        PostalCode: string;
+
+        /**
+         * The Country of the Address
+         */
+        Country: CountryISO;
+    }
+
+    interface CreateAddress {
+        /**
+         * The first line of the address
+         */
+        AddressLine1: string;
+
+        /**
+         * The second line of the address
+         */
+        AddressLine2?: string;
+
+        /**
+         * The city of the address
+         */
+        City: string;
+
+        /**
+         * The region of the address - this is optional except if the Country is US, CA or MX
+         */
+        Region?: string;
+
+        /**
+         * The postal code of the address - can be alphanumeric, dashes or spaces
+         */
+        PostalCode: string;
+
+        /**
+         * The Country of the Address
+         */
+        Country: CountryISO;
+    }
+}

package/typings/models/bankAccount.d.ts

@@ -0,0 +1,235 @@
+import { Models } from "../models";
+import { CountryISO } from "../types";
+import { address } from "./address";
+import { entityBase } from "./entityBase";
+
+export namespace bankAccount {
+    type CAData = BaseData & CADetails;
+
+    type USData = BaseData & USDetails;
+
+    type BankAccountType = "IBAN" | "GB" | "US" | "CA" | "OTHER";
+
+    type DepositAccountType = "CHECKING" | "SAVINGS";
+
+    type GBData = BaseData & GBDetails;
+
+    type OtherData = BaseData & OtherDetails;
+
+    type IBANData = BaseData & IBANDetails;
+
+    type Data = OtherData | CAData | GBData | IBANData | USData;
+
+    type DataIntersection = OtherData & CAData & GBData & IBANData & USData;
+
+    type CreationDetails =
+        | OtherDetails
+        | CADetails
+        | GBDetails
+        | IBANDetails
+        | USDetails;
+
+    interface BaseData extends entityBase.EntityBaseData {
+        /**
+         * The object owner's UserId
+         */
+        UserId: string;
+
+        /**
+         * The type of bank account
+         */
+        Type: BankAccountType;
+
+        /**
+         * The name of the owner of the bank account
+         */
+        OwnerName: string;
+
+        /**
+         * The address of the owner of the bank account
+         */
+        OwnerAddress: address.AddressType;
+
+        /**
+         * @deprecated
+         */
+        Details?: Models.BankAccountDetails;
+
+        /**
+         * Whether the bank account is active or not
+         */
+        Active: boolean;
+    }
+
+    interface IBANDetails {
+        Type: "IBAN";
+
+        /**
+         * The address of the owner of the bank account
+         */
+        OwnerAddress: address.AddressType;
+
+        /**
+         * The name of the owner of the bank account
+         */
+        OwnerName: string;
+
+        /**
+         * The IBAN of the bank account
+         */
+        IBAN: string;
+
+        /**
+         * The BIC of the bank account
+         */
+        BIC?: string;
+    }
+
+    interface USDetails {
+        Type: "US";
+
+        /**
+         * The address of the owner of the bank account
+         */
+        OwnerAddress: address.AddressType;
+
+        /**
+         * The name of the owner of the bank account
+         */
+        OwnerName: string;
+
+        /**
+         * The account number of the bank account. US account numbers must be digits only.
+         */
+        AccountNumber: string;
+
+        /**
+         * The ABA of the bank account. Must be numbers only, and 9 digits long
+         */
+        ABA: string;
+
+        /**
+         * The type of account
+         */
+        DepositAccountType?: DepositAccountType;
+    }
+
+    interface CADetails {
+        Type: "CA";
+
+        /**
+         * The address of the owner of the bank account
+         */
+        OwnerAddress: address.AddressType;
+
+        /**
+         * The name of the owner of the bank account
+         */
+        OwnerName: string;
+
+        /**
+         * The branch code of the bank where the bank account. Must be numbers only, and 5 digits long
+         */
+        BranchCode: string;
+
+        /**
+         * The institution number of the bank account. Must be numbers only, and 3 or 4 digits long
+         */
+        InstitutionNumber: string;
+
+        /**
+         * The account number of the bank account. Must be numbers only. Canadian account numbers must be a maximum of 20 digits.
+         */
+        AccountNumber: string;
+
+        /**
+         * The name of the bank where the account is held. Must be letters or numbers only and maximum 50 characters long.
+         */
+        BankName: string;
+    }
+
+    interface GBDetails {
+        Type: "GB";
+
+        /**
+         * The address of the owner of the bank account
+         */
+        OwnerAddress: address.AddressType;
+
+        /**
+         * The name of the owner of the bank account
+         */
+        OwnerName: string;
+
+        /**
+         * The sort code of the bank account. Must be numbers only, and 6 digits long
+         */
+        SortCode: string;
+
+        /**
+         * The account number of the bank account. Must be numbers only. GB account numbers must be 8 digits long.
+         */
+        AccountNumber: string;
+    }
+
+    interface OtherDetails {
+        Type: "OTHER";
+
+        /**
+         * The address of the owner of the bank account
+         */
+        OwnerAddress: address.AddressType;
+
+        /**
+         * The name of the owner of the bank account
+         */
+        OwnerName: string;
+
+        /**
+         * The Country of the Address
+         */
+        Country: CountryISO;
+
+        /**
+         * The BIC of the bank account
+         */
+        BIC: string;
+
+        /**
+         * The account number of the bank account. Must be numbers only. Canadian account numbers must be a maximum of 20 digits.
+         */
+        AccountNumber: string;
+    }
+
+    interface DebitedBankAccountData {
+        /**
+         * The name of the owner of the bank account
+         */
+        OwnerName: string;
+
+        /**
+         * The account number of the bank account. Must be numbers only. Canadian account numbers must be a maximum of 20 digits.
+         */
+        AccountNumber: string;
+
+        /**
+         * The IBAN of the bank account
+         */
+        IBAN: string;
+
+        /**
+         * The BIC of the bank account
+         */
+        BIC: string;
+
+        /**
+         * The Type of the bank account
+         */
+        Type: BankAccountType;
+
+        /**
+         * The Country ISO
+         */
+        Country: CountryISO;
+    }
+}

package/typings/models/bankingAlias.d.ts

@@ -0,0 +1,97 @@
+import { CountryISO, PickPartialRequired } from "../types";
+import { entityBase } from "./entityBase";
+
+export namespace bankingAlias {
+    type BankingAliasType = "IBAN";
+
+    interface BankingAliasData extends entityBase.EntityBaseData {
+        /**
+         * The user ID who is credited (defaults to the owner of the wallet)
+         */
+        CreditedUserId: string;
+
+        /**
+         * The ID of a wallet
+         */
+        WalletId: string;
+
+        /**
+         * The Country of the Address
+         */
+        Country: CountryISO;
+
+        /**
+         * The type of banking alias (note that only IBAN is available at present)
+         */
+        Type: BankingAliasType;
+
+        /**
+         * The owner of the wallet/banking alias
+         */
+        OwnerName: string;
+
+        /**
+         * Whether the banking alias is active or not
+         */
+        Active: boolean;
+
+        VirtualAccountPurpose: string;
+    }
+
+    interface IBANBankingAliasData extends BankingAliasData {
+        /**
+         * The type of banking alias (note that only IBAN is available at present)
+         */
+        Type: "IBAN";
+
+        /**
+         * The IBAN of the banking alias
+         */
+        IBAN: string;
+
+        /**
+         * The BIC of the banking alias
+         */
+        BIC: string;
+    }
+
+    interface CreateIBANBankingAlias {
+        /**
+         * The type of banking alias (note that only IBAN is available at present)
+         */
+        Type: "IBAN";
+
+        /**
+         * The ID of a wallet
+         */
+        WalletId: string;
+
+        /**
+         * The owner of the wallet/banking alias
+         */
+        OwnerName: string;
+
+        /**
+         * The Country of the Address
+         */
+        Country: CountryISO;
+
+        /**
+         * Custom data that you can add to this object
+         */
+        Tag?: string;
+    }
+
+    interface UpdateIBANBankingAlias {
+        /**
+         * The ID of the BankingAlias
+         */
+        Id: string;
+
+        /**
+         * Whether the banking alias is active or not
+         * Caution: Setting this value to false is irreversible
+         */
+        Active?: boolean;
+    }
+}

package/typings/models/billing.d.ts

@@ -0,0 +1,42 @@
+import { Models } from "../models";
+import { address } from "./address";
+
+export namespace billing {
+    interface BillingData {
+        Address: Models.Address | address.AddressData | string;
+    }
+
+    interface CompleteBillingData {
+        FirstName: string;
+
+        LastName: string;
+
+        Address: address.AddressData;
+    }
+
+    // todo: replace with CompleteBillingData
+    interface BillingOrShippingRecurringPayInData {
+        FirstName: string;
+
+        LastName: string;
+
+        Address: address.AddressData;
+    }
+
+    interface CreateBilling {
+        /**
+         * The name of the user
+         */
+        FirstName: string;
+
+        /**
+         * The last name of the user
+         */
+        LastName: string;
+
+        /**
+         * The address
+         */
+        Address: address.CreateAddress;
+    }
+}

package/typings/models/birthplace.d.ts

@@ -0,0 +1,9 @@
+import { CountryISO } from "../types";
+
+export namespace birthplace {
+    interface Birthplace {
+        City: string;
+
+        Country: CountryISO;
+    }
+}

package/typings/models/card.d.ts

@@ -0,0 +1,119 @@
+import { CountryISO, CurrencyISO } from "../types";
+import { entityBase } from "./entityBase";
+
+export namespace card {
+    type CardType = "CB_VISA_MASTERCARD" | "DINERS" | "MASTERPASS" | "MAESTRO" | "P24" | "IDEAL" | "BCMC" | "PAYLIB";
+
+    type CardStatus = "CREATED" | "VALIDATED" | "ERROR";
+
+    type CardValidity = "UNKNOWN" | "VALID" | "INVALID";
+
+    type CardInfoType = "DEBIT" | "CREDIT" | "CHARGE CARD";
+
+    interface CardData extends entityBase.EntityBaseData {
+        /**
+         * The expiry date of the card - must be in format MMYY
+         */
+        ExpirationDate: string;
+
+        /**
+         * A partially obfuscated version of the credit card number
+         */
+        Alias: string;
+
+        /**
+         * The provider of the card
+         */
+        CardProvider: string;
+
+        /**
+         * The type of card
+         */
+        CardType: CardType;
+
+        /**
+         * The Country of the Address
+         */
+        Country: string;
+
+        /**
+         * The card product type - more info
+         */
+        Product: string;
+
+        /**
+         * The bank code
+         */
+        BankCode: string;
+
+        /**
+         * Whether the card is active or not
+         */
+        Active: boolean;
+
+        /**
+         * The currency - should be ISO_4217 format
+         */
+        Currency: CurrencyISO;
+
+        /**
+         * Whether the card is valid or not. Once they process (or attempt to process) a payment with the card we are able to indicate if it is "valid" or "invalid".
+         * If they didn’t process a payment yet the "Validity" stay at "unknown".
+         */
+        Validity: CardValidity;
+
+
+        /**
+         * The unique identifier of the user the card belongs to.
+         */
+        UserId: string;
+
+        /**
+         * A unique representation of a 16-digits card number
+         */
+        Fingerprint: string;
+
+        /**
+         * The cardholder’s name shown on the payment card
+         */
+        CardHolderName: string;
+    }
+
+    interface UpdateCard {
+        Id: string;
+        Active?: false;
+        CardHolderName?: string;
+    }
+
+    interface CardInfoData {
+        /**
+         * The 6-digit bank identification number (BIN) of the card issuer.
+         */
+        BIN: string;
+
+        /**
+         * The name of the card issuer.
+         */
+        IssuingBank: string;
+
+        /**
+         * The country where the card was issued.
+         */
+        IssuerCountryCode: CountryISO;
+
+        /**
+         * The type of card product: DEBIT, CREDIT, CHARGE CARD.
+         */
+        Type: CardInfoType;
+
+        /**
+         * The card brand. Examples include: AMERICAN EXPRESS, DISCOVER, JCB, MASTERCARD, VISA, etc.
+         */
+        Brand: string;
+
+        /**
+         * The subtype of the card product. Examples include: CLASSIC, GOLD, PLATINUM, PREPAID, etc.
+         */
+        SubType: string;
+    }
+}