mainstack-payments 0.5.22 → 0.5.23

package/README.md

@@ -67,14 +67,14 @@ The config object should contain the following properties:
 
 * `currency*`: The currency to be used for the payment
 
-* `reference*`: Uniquely generated identifier for this payment
-
 * `transactionFeesSlug*`: The slug of the transaction fees to be applied to the payment usually determined by the backend, e.g 'store-pro-plan'
 
 * `userAllowsWalletPayment*`: A boolean value that states if the merchant has allowed wallet payment
 
 * `userAllowsCardPayment*`: A boolean value that states if the merchant has allowed card payment
 
+* `userAllowsCryptoPayment*`: A boolean value that states if the merchant has allowed crypto wallet payments.
+
 * `metadata*`: An object that contains additional information about the payment. See more on this [here](#metadata)
 
 * `baseUrl*`: The base URL of the legacy API. This API is what is used primarily to make payments. It is used initialise, charge and verify payment.
@@ -93,12 +93,16 @@ The config object should contain the following properties:
 
 * `ip`: This is for the user's ip address to determine their tax fee. Only needed if you want to collect tax fees.
 
-* `paymentOptions`: An array of payment options that should be enabled for the user can select from. The options are 'paystack', 'startbutton', 'wallet', 'stripe'
+* `paymentOptions`: An array of payment options that should be enabled for the user can select from. The options are 'paystack', 'startbutton', 'wallet', 'stripe', 'crypto'
 
-* `paystackRedirectUrl`: The URL to redirect to after a successful payment with Paystack or Startbutton. this is required if paystack or startbutton is enabled. More on this can be found [here](#paystackredirecturl)
+* `paymentRedirectUrl`: The URL to redirect to after a successful payment with Paystack, Startbutton or Stripe UK payments (which may require 3DS). More on this can be found [here](#paystackredirecturl)
+
+* `cryptoRedirectUrl`: The URL to redirect to after a successful crypto wallet payment. This is different to `paymentRedirectUrl` as you are fully in control of this page and should ideally be the receipt page. The following url query parameters will be added to the url from the payment library: `reference` : payment reference generated by mainstack, `payment_intent` : generated by stripe. This is required if `userAllowsCryptoPayment` is true.
 
 * `customizations`: This is an object that takes values that adjust layout, styling or display of elements on the library. See full description [here](https://app.joggr.io/app/documents/b5b2ff2f-550d-4057-bed3-441870eaaf5d/edit#customizations).
 
+* `paymentModel`: string that specifies if the payment model is 'ips' or 'default'
+
 #### metadata
 
 The `metadata` object should contain the following properties:
@@ -141,7 +145,7 @@ The `metadata` object should contain the following properties:
 
   * `phone`: For the PhoneNumber input. Default is false.
 
-The `paystackRedirectUrl` is the URL to redirect to after a successful payment with Paystack or Startbutton. This page will be created by you and should contain the following code:
+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
 import { useEffect } from "react";
@@ -159,7 +163,7 @@ const PostMessagePage = () => {
 export default PostMessagePage;
 ```
 
-The aim of this is to send a postMessage to the iframe that loads Startbutton or Paystack to let them know that payment is complete and they can close the iframe and verify the payment.
+The aim of this is to send a postMessage to the iframe that loads the payment option to let them know that payment is complete and they can close the iframe and verify the payment.
 
 ## Extra Props