Skip to main content

Stripe Payment integration

Yellow.ai Integration with Stripe Payment Gateway allows the bot to generate Stripe payment links and view a specific payment status.

Connecting Stripe payment with yellow.ai​

Get Secret key from your Stripe app​

  • Go to the Stripe dashboard > Developer > API Keys > Copy the Secret key.

Connect Stripe with yellow.ai​

In a two-tier environment, you can connect an integration app in the Development environment. In a three-tier environment, you can connect the integration app either in Staging or Sandbox. All connected integrations are available in the live environment. To connect your Airpay account with Yellow.ai, follow these steps:

  1. Navigate to the Development/Staging environment and go to Extensions > Integrations > Payment  > Stripe.

  2. In Give account name, enter a unique name for the integration. You can use only lowercase alphanumeric characters and underscores (_).

  3. Enter the Key secret that you copied using the previous sections.

  4. Click Connect.

  5. To add another account, click + Add account and proceed with the previous steps. You can add a maximum of 15 accounts.

Configure webhook URL in Stripe dashboard.​

The webhook URL serves as a callback endpoint where Stripe can send notifications or updates regarding payment events, enabling your application to respond accordingly.

  1. Copy the webhook URL from Stripe integration card.
  2. Go to the Stripe Dashboard > Developers > Webhooks > Add endpoint.
  3. Enter the webhook URL in Endpoint field.
  4. Select checkout.session.completed event in the select events to listen field.

Receiving Stripe payment status event in your bot​

Enable the following event under Events section:

  1. In Development/Staging environment, go to Studio > Event > Custom events.

  2. Navigate to the stripe-payment-gateway event, click on the more options icon and select Activate.

    alt_text

EventDescription
Stripe Payment StatusIn case of payments/refunds the status can be checked with these details.

Once the Stripe account is connected, you can generate the paument link directly in bot conversations.

  1. Go to Development/Staging environment and navigate to Studio > Build > Select the flow where you want to add the Generate payment link node.

  2. Click Add node > Integrations > Stripe payment gateway.

    OptionDatatypeDescription
    Amount*numberChoose a variable that contains the amount to be used in the payment link.
    Currency*StringChoose a variable that contains the currency to be used in the payment link
    Description*StringChoose a variable that contains the description to be included in the payment link.
    Custom metadata*ObjectChoose a variable that contains the custom metadata to be included in the payment link.
    Product image*stringChoose a variable that contains the URL of the product image to be included in the payment link.
    Product name*StringChoose a variable that contains the name of the product to be included in the payment link.
    After Completion typeStringThe action to be taken after the payment is completed. You can choose to redirect the user to a specific URL or display a custom message.
    URL or Custom MessageStringFor Redirect URL: Enter the URL to which the user should be redirected.
    For Show Custom Message: Enter the custom message that you want to display to the user.
    Parse API response-Choose the function that you want to use to parse and handle the response received from the API after completing the payment. Parsing the API response allows the bot to extract relevant information and take appropriate actions based on the response.

Reference

For more information about action nodes you use here, refer this doc