Print

Parameters

MSWR general parameters and their default values

Parameter Type Required Default Value Description
amount integer Yes N/A The amount to be charged in the smallest currency unit (e.g., cents for USD).
currency string No 'usd' The currency code in ISO 4217 format (e.g., ‘usd’, ‘eur’).
email string No logged-in user email or blank if no user logged in The customer’s email address. Pre-fills the Stripe Checkout, If not specified, Stripe will require the user to enter an email.
product string No 'Product' The name of the product being purchased.
quantity integer No 1 The quantity of the product being purchased.
success_url string No plugin settings URL to redirect the user to upon successful payment.
cancelled_url string No plugin settings URL to redirect the user to if the payment is cancelled.
user_meta string or array of string No '' User defined tag which can be used to identify a transaction in, or pass information to the webhook callback handler

Data Structures

Name Type Values
transaction array
  • transaction_id
  • session_id
  • payment_intent_id
  • amount
  • surcharge
  • currency
  • status
  • gateway
  • payment_method
  • customer_email
  • customer_ip
  • user_meta
  • created_at
  • updated_at
Page Navigation