Embed Payment Widget Documentation

What is the Embed Payment Widget?

The Embed Payment Widget allows merchants to generate a payment link dynamically via URL parameters and redirect customers directly to the payment gateway.

How It Works

1. Embed or navigate to the widget URL in your frontend.
2. Pass required parameters as query params in the URL.
3. The widget will auto-generate a payment link and redirect.
4. If there’s an error, the widget will display a helpful message.

Widget URL Format

https://gateway.dashx.xyz/embed?title=<TITLE>&productName=<PRODUCT_NAME>&description=<DESCRIPTION>&amount=<AMOUNT>&expTime=<EXP_TIME>&merchantId=<MERCHANT_ID>&api_key=<API_KEY>

Required Parameters

• title: Title for the payment (e.g. "Order #123")
• productName: Name of the product
• description: Short description of the payment
• amount: Amount to be charged (as a string)
• expTime: Time until expiration (in minutes)
• merchantId: Your merchant ID
• api_key: API key for authentication

Optional Parameters

• allow_promo_codes: Pass true to enable promo code support
• customer_id: Optional identifier for an existing customer

Behavior

• On valid params, a payment link is generated using CreateEmbedPaymentLink.
• On success, user is redirected to: /gateway?slug=your-payment-slug
• On failure, an error is displayed to the user.

Success Response (Redirect)

{
  "message": "Payment link created successfully",
  "id": "pl_xxxxx",
  "slug": "unique-payment-slug",
  "link": "https://gateway.dashx.xyz/unique-payment-slug",
  "customer_id": "optional_customer_id"
}

Error UI States

• Missing required parameters will show: "Invalid Link"
• Server or network failure will show a toast with the error message

Example Embed

<iframe 
  src="https://gateway.dashx.xyz/embed?title=<TITLE>&productName=<PRODUCT_NAME>&description=<DESCRIPTION>&amount=<AMOUNT>&expTime=<EXP_TIME>&merchantId=<MERCHANT_ID>&api_key=<API_KEY" 
  width="100%" 
  height="400px" 
  frameBorder="0"
></iframe>