mainstack-payments 1.0.32 → 1.0.34

package/README.md

@@ -83,9 +83,13 @@ The config object should contain the following properties:
 
 * `mainstackProductId`: A User's ID for a particular product, e.g store\_id, bookings\_id etc.
 
-* `STRIPE_SECRET_KEY`: Stripe secret key for stripe payments, usually stored in an env.
+* `STRIPE_SECRET_KEY*`: Stripe secret key for stripe payments, usually stored in an env.
 
-* `STRIPE_SECRET_KEY_GBP`: Stripe secret key for stripe payments in GBP, usually stored in an env.
+* `STRIPE_SECRET_KEY_GBP*`: Stripe secret key for stripe payments in GBP, usually stored in an env.
+
+* `STRIPE_SECRET_KEY_CAD*`: Stripe secret key for stripe payments in CAD, usually stored in an env.
+
+* `merchantBearsTax` : This is a boolean to indicate if the merchant bears tax charges or not.
 
 * `applyTrancheFee`: Boolean that is passed to the transaction fees endpoint and dictates if a tranch fee should be applied for transaction fees.This is specifically for Pay In Tranches payments. Default is false.
 
@@ -103,21 +107,33 @@ The config object should contain the following properties:
 
 * `paymentModel`: string that specifies if the payment model is 'ips' or 'default'
 
+* `isFreeTrial`: Boolean to specify if a subscription payment is a free trial.
+
+* `merchantCountry`: A string that returns the country of the merchant.
+
+* `isPowerUser`: A Boolean to specify if a merchant is a power user.
+
+* `itemsList`: This is an Array of objects used when multiple products are being purchased at once. e.g: event tickets or cart products. See object values [here](https://app.joggr.io/app/documents/b5b2ff2f-550d-4057-bed3-441870eaaf5d/edit#items-list)
+
 #### metadata
 
 The `metadata` object should contain the following properties:
 
-* -`productName`: The name of the product being paid for
+* `productName`: The name of the product being paid for.
+
+* `productImage`: The image url of the product.
+
+* `type`: The type of product being paid for.
 
-* -`type`: The type of product being paid for
+* `account_id`: The account ID of the user making the payment
 
-* -`account_id`: The account ID of the user making the payment
+* `user_id`: The user ID of the user making the payment
 
-* -`user_id`: The user ID of the user making the payment
+* `product_id`: The product ID of the product being paid for
 
-* -`product_id`: The product ID of the product being paid for
+* `mainstack_product_type`: What Category of Mainstack Product is being paid for, accepted values are 'store', 'editor', 'bookings', 'mediakit', 'invoicing', 'hosted\_courses'
 
-* -`mainstack_product_type`: What Category of Mainstack Product is being paid for, accepted values are 'store', 'editor', 'bookings', 'mediakit', 'invoicing', 'hosted\_courses'
+* `quantity`: The quantity of a product being purchased.
 
 * `[key:string]` : Any other key-value pair that you want to add to the metadata object
 
@@ -145,6 +161,20 @@ The `metadata` object should contain the following properties:
 
   * `phone`: For the PhoneNumber input. Default is false.
 
+* `summaryWidth`: This takes a width in pixels to set a fixed width for the summary section.
+
+#### itemsList
+
+* `name*`: String for the name of the product.
+
+* `price*`: Type of Number for the product price.
+
+* `currency*`: Currency code of the price.
+
+* `quantity*` : The amount of each product being purchased.
+
+* `image`: Optional image url for each product.
+
 The `paymentRedirectUrl` is the URL to redirect to after a successful payment with Paystack, Startbutton or Stripe UK. This page will be created by you and should contain the following code:
 
 ```typescript
@@ -177,12 +207,22 @@ Other Props that can be passed to the `MainstackPayments` component are:
 
 * `defaultFormValues`: This is an object with `fullname` and `email` keys. Their values are passed to their respective inputs as default values.
 
+* `preCheckoutBanner`: This takes a ReactNode to add a banner to the top of the checkout page.
+
+* `height`: this takes a value in pixels to set a fixed height for the checkout library component.
+
+* `FooterElement` : This takes a ReactNode to display a component at the bottom of the checkout page.
+
 * `onPaymentComplete`: This is a callback function that is called when the payment is completed. It contains a payload that will include the amount, default input values, and reference of the payment, as well as some other optional data.
 
 * `onGoBack`: This is a callback function that is called when the user clicks the back button on the payment page.
 
 * `onInitializePayment`: This is an async function is called just as the payment is about to be initialized and is useful for triggering any actions before the payment is initialized, like validating your custom form or making an api call to validate something with the user's name or email before proceeding with payment. It contains an argument that has the values for the default form inputs, and must return a promise that resolves an object with a `terminate` boolean property. The payment initialization will terminate immediately the promise resolves depending on what the value of `terminate` is.
 
+* `onDiscountApplied`: This is a callback that gets called when discount get's applied on checkout.
+
+* `onDiscountRemoved`: This is a callback that get's called when discount is removed from the checkout.
+
 ```typescript
       <MainstackPayments
               paymentConfig={config}