@motopays/pay-form 1.0.10-rc.2 → 1.0.10-rc.4

package/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+## 1.0.10
+
+### Breaking changes
+
+##### Payment model
+- cusomterAuthToken field renamed to userAuthToken
+- customerId field renamed to userId
+- env field deleted (set urls.billingProfiles and urls.processing from 'settings' model instead)
+
+##### Settings model
+- the model has become mandatory 
+- isEmailFieldVisible field deleted
+- merchantInfo field type changed. Now it's: {
+         visible: boolean,
+         text: string,
+         links?: ILink[]
+    }
+- isMerchantInfoVisible field renamed and moved to merchantInfo.visible
+- merchantLinks field renamed and moved to merchantInfo.links
+- urls field added instead of env field from 'payment'. Now it's: {
+        //example: "https://processing.dev.motopays.com"
+         processing: string;
+         billingProfiles: string;
+    }
+
+### Added
+- chargeTerms field added to settings model. This field allows to configure checkboxes that have to be selected by users (otherwise, users cannot make payments).
+    The interface of the field: {
+         visible: boolean,
+         checkboxes?: ITermCheckbox[],
+         text: string;
+    }
+
+    The interface of ITermCheckbox: {
+         text: string;
+         link?: ILink;
+    }
+- availableCardBrands field added to settings model. It's an array of strings which will be shown to users as available card payment methods. Now it supports these strings: "american-express" | "discover" | "jcb" | "maestro" | "mastercard" | "unionpay" | "visa"
+- Checkboxes
+- Text for the checkboxes
+- Payment methods icons
+- Transactions secured icons
+
+### Changes
+- Styles for links, indent and text at the bottom of the payment form

package/README.md

@@ -23,9 +23,8 @@ import "@motopays/pay-form/lib/styles/styles.css";
 const payment$ = document.querySelector("#payment");
 
 payment$.payment = {
-  customerAuthToken?: string;
-
-  env: EnvironmentType; //one of strings: dev, stage, live, prod
+  userAuthToken?: string;
+  userId: string;
   
   paymentId: string;
   amount: number;
@@ -33,12 +32,11 @@ payment$.payment = {
   tax?: number;
   orderType?: OrderType; //one of numbers: Regular, FreeTrial
   currency: string;
-  customerId: string;
   merchantId: string;
   initiator?: PaymentInitiatorType; //one of strings: Customer, Merchant
 
-  webhookUrl: string;
-  returnUrl: string;
+  webhookUrl?: string;
+  returnUrl?: string;
 
   description: string;
   email?: string;
@@ -53,20 +51,41 @@ payment$.payment = {
     country: string;
     zip: string;
   }
-
-  customEndpoints?: {
-    billingProfiles?: string;
-    processing?: string
-  }
 }
 
 payment$.settings = {
-  isPhoneNumberFieldVisible: false;
-  isCloseButtonVisible: true;
-  isMerchantInfoVisible: true;
-  merchantInfo: 'The info';
-  merchantLinks: { text: string; href: string; } [];
-
+  isPhoneNumberFieldVisible: boolean;
+  isCloseButtonVisible: boolean;
+
+  urls: {
+    //For example, "https://billingprofiles.dating.com
+    billingProfiles: string;
+    processing: string;
+  };
+
+  //Now it supports these strings: "american-express" | "discover" | "jcb" | "maestro" | "mastercard" | "unionpay" | "visa"
+  availableCardBrands: string[] or CreditCardTypeCardBrandId[];
+
+  chargeTerms: {
+    visible: boolean;
+    text?: string;
+    checkboxes?: { 
+      text: string; 
+      link: { 
+        text: string; 
+        href: string; 
+      }
+    } [];
+  };
+
+  merchantInfo: {
+    visible: boolean;
+    text?: string;
+    links?: { 
+      text: string; 
+      href: string; 
+    } [];
+  };
 }
 
 payment$.addEventListener("close", (event) => {
@@ -88,19 +107,18 @@ declare module "@motopays/pay-form/pay";
 
 | Field                    | Type   | Description                                                                                                                                                                          |
 | ------------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| customerAuthToken          | string | End-customer authorization token to access Moto services                                                                                                              |
-| env **\*required**         | EnvironmentType or string | App environments, for testing, develop and production. Currently accepted: {test, qa1, qa2, qa3, dev, live, prod}                                                                                          |
+| userAuthToken              | string | End-user authorization token to access Motopays services                                                                                                              |
+| userId **\*required**      | string | External end-user Id generated on the merchant side (not Motopays)                                                     |
 | paymentId **\*required**   | string | Id of a payment                                                                                                             |
 | amount **\*required**      | number | Payment amount                                                                                                                                                                       |
 | amountType                 | AmountType or string | Type of amount can be only one of the following values: {GrossWithoutGst, Net, Gross}                                                                                                             |
 | tax                        | number | Payment tax                                                                                                             |
 | orderType                  | OrderType or string | Type of order can be only one of the following values: {Regular, FreeTrial}                                                                                                             |
 | currency **\*required**    | string | Payment currency in ISO_4217 format. Currently accepted: {gbp, eur, usd}                                                                                                             |
-| customerId **\*required**  | string | End-customer Id in merchant's system. That parameter can be used to find a best button appearance for the particular customer.                                                       |
-| merchantId **\*required**  | string | Merchant's identificator, issued by Moto.                                        |
+| merchantId **\*required**  | string | Merchant's identificator, issued by Motopays.                                        |
 | initiator                  | PaymentInitiatorType or string | Identifies who of 2 types initiated the payment. Currently accepted: {Merchant, Customer}                                                       |
-| webhookUrl                 | string | URL where the Moto will send hooks about the payment status changes                                                                                                                  |
-| returnUrl **\*required**   | string | After the payment completed, customer will be redirected into this Url                                                                                                               |
+| webhookUrl                 | string | URL where the Motopays will send hooks about the payment status changes                                                                                                                  |
+| returnUrl                  | string | The URL to which the user will be redirected after completing some types of payment, such as PayPal                                                                                                               |
 | description                | string | Short order description for the customer                                                                                                                                             |
 | email                      | string | End-customer e-mail. That parameter can be used to find a best button appearance for the particular customer.                                                                        |
 | details                    | ISimple<any> | Additional information about payment                                                                       |
@@ -112,31 +130,83 @@ declare module "@motopays/pay-form/pay";
 | billingAddress.state       | string | State of a customer bank account                                                                       |
 | billingAddress.country     | string | Country of a customer bank account (ISO 3166-1 alpha-2 country code). Example: US                                                                      |
 | billingAddress.zip         | string | Zip of a customer bank account                                                                       |
-| customEndpoints.billingProfiles | string | Custom set endpoint for BillingProfiles                                                                        |
-| customEndpoints.processing | string | Custom set endpoint for Processing 
 
 ### Settings interface
 
 | Field                       | Type    | Description                                                                 |
 |-----------------------------|---------|-----------------------------------------------------------------------------|
+| urls **\*required**         | IServicesUrls  | The necessary services urls |
+| urls.processing **\*required**  | string  | The processing service URL |
+| urls.billingprofiles **\*required**  | string  | The billing profiles service URL |
 | isPhoneNumberFieldVisible   | boolean | Whether to show the phone input field when creating a map                   |
 | isCloseButtonVisible        | boolean | Whether to show a window close button in the top right corner of the screen |
-| isMerchantInfoVisible       | boolean | Whether to show information about merchant                                  |
-| merchantInfo                | string  | The information displays in merchant info section                           |
-| merchantLinks               | ILink[] | The array of link which will be displayed in merchant info section          |
+| merchantInfo                | IMerchantInfoSettings  | The information displays in merchant info section                           |
+| merchantInfo.visible        | boolean  | Whether to show the merchant information                          |
+| merchantInfo.text           | string   | The information about a merchant                          |
+| merchantInfo.links          | ILink[]  | The array of merchant links. For example, Policy and Terms                         |
+| chargeTerms                 | IChargeTermsSettings | The charge terms section |
+| chargeTerms.visible         | boolean | Whether to show the charge terms |
+| chargeTerms.checkboxes      | ITermCheckbox[] | The checkboxes that, without being selected, the user will not be able to make a payment. All these checkboxes have to be selected by user to be able to make a payment |
+| chargeTerms.text            | string   | The text of charge terms. For example, description of subscription plan |
+| availableCardBrands         | string[] or CreditCardTypeCardBrandId[] | The сard brands for which icons will be displayed on the form as card payment methods. Currently accepted: {american-express, discover, jcb, maestro, mastercard, unionpay, visa} |
+
+
+ILink interface:
+```
+interface ILink {
+    text: string;
+    href: string;
+}
+```
 
-Example of merchant links:
+ITermCheckbox interface:
 ```
-merchantLinks: [
-  {
-    text: 'Terms of service', 
-    href: 'https://my.host.com/terms_of_service',
-  },
-  {
-    text: 'Privacy policy', 
-    href: 'https://my.host.com/privacy_policy',
-  }
-]
+interface ITermCheckbox {
+    text: string;
+    link?: ILink;
+}
+```
+
+Example of merchantInfo:
+```
+merchantInfo: {
+  "visible": true,
+  "text": "The vendor prides itself on designing and implementing state-of-the-art payment infrastructures that cater to a wide range of commercial activities. Specializing in the creation of robust payment processing platforms, the merchant provides tailored solutions that support the dynamic needs of the global market",
+  "links": [
+    {
+      "text": "Terms",
+      "href": "https://www.google.com/"
+    },
+    {
+      "text": "Policy",
+      "href": "https://www.google.com/"
+    }
+  ]
+}
+```
+
+Example of chargeTerms:
+```
+chargeTerms: {
+  "visible": true,
+  "text": "By checking this box, I am affirming my full and complete understanding of, as well as my agreement to, all the terms and conditions that were previously presented to me, acknowledging that they form a binding contractual agreement.",
+  "checkboxes": [
+    {
+      "text": "I hereby agree to the conditions previously outlined.",
+      "link": {
+        "text": "Link to the application",
+        "href": "https://www.google.com/"
+      }
+    },
+    {
+      "text": "I validate the foregoing stipulations.",
+      "link": {
+        "text": "Google",
+        "href": "https://www.google.com/"
+      }
+    }
+  ]
+},
 ```
 
 ### Output events
@@ -201,141 +271,6 @@ IThreeDsData {
 IRedirectData {
     location: string;
 }
-``` 
-
-### Custom Endpoints
-
-If it's necessary to override endpoints, It's possible to do by overriding them through CustomEndpoint field.
-
-BillingProfiles endpoints in use of this form:
-```
-Get method: {billingProfilesEndpoint}/api/UserPaymentMethods
-Description: Payment methods user's already used before
-Returns: [ 
-  {
-    id: string;
-    isDefault: boolean;
-    name: string;
-    rebill: string;
-    type: string;
-  },
-  ...
-]
-
-Delete method: {billingProfilesEndpoint}/api/UserPaymentMethods/${cardId}
-Description: delete card user's used before
-Returns: void
-```
-
-Processing endpoints in use of this form:
-```
-Get method: {processingEndpoint}/api/merchants/${merchantId}/settings
-Description: Available apms
-Query params: { 
-  currency: string,
-  payerId: string
-}
-Returns: {
-   payments: [
-    {
-      name: string;
-      logo: string;
-    },
-    ...
-   ]
-}
-
-Get method: {processingEndpoint}/api/merchants/${merchantId}/payments/${paymentId}
-Description: Get payment info
-Returns:
-{
-    action?: {
-        name: string;
-        data: IThreeDsData | IRedirectData | any;
-    }
-    ip: string;
-    merchant: string;
-    order: {
-        invoiceId: string;
-        details: string;
-    }
-    payment: {
-        paymentId: string;
-        state: PaymentState;
-        rebillAnchor: string;
-        info: {
-            completeProcessingTime?: Date;
-            currency: string;
-            paymentType: string;
-            paymentSystem: string;
-            paymentRequisites?: string;
-            price: number
-        }
-        rejectionDetails?: {
-            hardDecline: boolean;
-            message?: string;
-            problemSolvingTips: string[];
-            rejectionCode: number;
-        }
-    }
-    taxInfo: {
-        abbreviation: string;
-        price: number;
-        priceNet: number;
-        tax: number;
-    }
-    user: {
-        id: string;
-    }
-}
-
-Get method: {processingEndpoint}/api/security/key/${secretId}
-Description: Get secret key for encryption (it's better to contact Moto team). By default secretId = 2
-Returns: string
-
-Post method: {processingEndpoint}/api/merchants/{merchantId}/payments
-Description: Make payment
-Body: It's better to contact Moto team
-Returns: {
-    action?: {
-        name: string;
-        data: IThreeDsData | IRedirectData | any;
-    }
-    ip: string;
-    merchant: string;
-    order: {
-        invoiceId: string;
-        details: string;
-    }
-    payment: {
-        paymentId: string;
-        state: PaymentState;
-        rebillAnchor: string;
-        info: {
-            completeProcessingTime?: Date;
-            currency: string;
-            paymentType: string;
-            paymentSystem: string;
-            paymentRequisites?: string;
-            price: number
-        }
-        rejectionDetails?: {
-            hardDecline: boolean;
-            message?: string;
-            problemSolvingTips: string[];
-            rejectionCode: number;
-        }
-    }
-    taxInfo: {
-        abbreviation: string;
-        price: number;
-        priceNet: number;
-        tax: number;
-    }
-    user: {
-        id: string;
-    }
-}
 ```
 
 ### Webpack 5 Issues