# Bepaid ## **How to Connect** To connect the **bePaid** payment system, you will need a **Store ID**, **secret key**, and **public key**. Once you receive these credentials, proceed to the settings in **Salebot**. {% hint style="info" %} To obtain the **Store ID**, **secret key**, and **public key**, please contact **baPaid** technical support for assistance. {% endhint %} In **MaviBot**, open the **"Payment system"** section and select **bePaid**. Then enter the credentials you received.

Please note that the last field is a switch that selects the API hosting depending on the country of use: **Belarus** or **Russia**.

## **How to Generate a Payment Link** To generate a payment link, you need to set a value for the **payment\_sum** variable (for example: **150** or **100.55** — use a dot as the decimal separator). Once the **payment\_sum** variable is set, the **bepaid\_pay\_url** variable will automatically appear. You can display this variable on the screen as a link or place it on a button with the text **"Pay"**. The payment link will look like this:\ Before setting the **payment\_sum** variable, you can also define the following optional variables to customize the payment. {% hint style="info" %} By default, the currency is set to **Belarusian ruble**. If you need to use a different currency, set a value for the **currency** variable. {% endhint %}

Function Parameters	Description	More Information
currency	Payment currency in ISO 4217 format	For example: USD
language	Payment page language Default: en.	Allowed values: en – English es – Spanish tr – Turkish de – German it – Italian ru – Russian zh – Chinese fr – French da – Danish sv – Swedish no – Norwegian fi – Finnish pl – Polish ja – Japanese uk – Ukrainian be – Belarusian ka – Georgian ro – Romanian
payment_description	Payment Description
link_expired	Payment Link Expiration Set the expiration date in the format dd.mm.yyyy (for example: 25.06.2025). By default, the payment must be completed within 24 hours.	You can also use the "Assign Variables on Redirect" field to set: `link_expired = current_date + 2` — the link will be valid for 2 days until 00:00. You can also specify an exact expiration date and time in the format dd.mm.yyyy hh:mm (for example: 25.06.2025 12:23). By default, the payment must be completed within 24 hours. Standard variables can also be used. For example, to set the link validity to 30 minutes: time = current_time + 30 link_expired = "#{current_date} #{time}"
russian_host	Indicator for Store Registered on Russian bePaid Host Set this parameter to 1 if your store is registered on bepaid.tech.	If you need to switch the host to Belarus, set this parameter to "" (empty value).
test_payments	This variable is used for test payments. To perform a test payment, add it with any value.
bepaid_attempts	Specifies the number of payment attempts. By default, 1 attempt is allowed.
сustomer_data	An array containing the payer’s first_name, last_name, and email. This data is required to send the receipt to the payer’s email and can be edited on the payment page.	The parameter must be passed as a JSON-formatted list of key-value pairs. For example: customer_data = ‘{“first_name”: “Sam”, “last_name”: “Smith”, “email”: “sam_smith@mavibot.ai” }’
bepaid_contract (conditionally required)	Payment Purpose by Token	Expected values: “recurring” – for regular payments with a set frequency “card_on_file” – for one-time or irregular payments, e.g., post-payment for a service

After the payment is completed, the **bepaid\_callback\_data** variable will be added for the customer. It contains the payment system’s response for the completed transaction. You can extract the required data from this dictionary using the **get** method. ## **How to Test Payments** To perform a test payment, before setting the **payment\_sum** variable, set the **test\_payments** variable with any value.\ Remember to remove it when running the bot in **live mode**! **Test cards:** * 4200000000000000 — success * 4005550000000019 — failed If something doesn’t work, compare your data with the official documentation: ## **Example of Generating a Payment Link** Let’s create a payment link for **100 Belarusian rubles** (default currency). Note: first, set the additional variables for configuration, then set **payment\_sum**. Variables can also be set earlier in the workflow, not necessarily in the same block — this is just an example. Finally, display the **bepaid\_pay\_url** variable in the desired location; it contains the generated payment link. ## **Subscription Management** The payment system integration allows you to create subscriptions for your customers. Before using this functionality in **Salebot**, create a subscription plan in your **bePaid** account. {% hint style="warning" %} If the **“Plans”** and **“Subscriptions”** menus do not appear in your account, please contact your manager. {% endhint %} **Creating a Subscription and Generating a Payment Link** Use the **get\_bepaid\_subscription\_url** function, passing the **plan\_id** parameter, where…


plan_id	plan_id is the ID of the plan in the bePaid system.

As a result, the function will create a subscription and return a payment link. Send the link to the customer and wait for the payment to be completed. Once the payment is successful, the subscription will be activated. The deal will receive the **bepaid\_subscription\_id** and **bepaid\_subscription\_status** variables, and a callback will be sent to the bot (see the **“How to Handle the Result”** section). ## **Retrieving Subscription Information** To get the current subscription details for a customer, call the **get\_bepaid\_subscription\_info** function and pass the **subscription\_id** parameter (the value can be taken from the **bepaid\_subscription\_id** variable). ## **Cancelling a Subscription** To cancel a subscription, use the **cancel\_bepaid\_subscription** function. This function accepts a single parameter: **subscription\_id** (the value can be taken from the **bepaid\_subscription\_id** variable). Upon successful cancellation, the **bepaid\_subscription\_status** variable will be set to **“canceled”**, and a callback will be sent to the bot (see the **“How to Handle the Result”** section). ## Subscription Statuses


trial	Active or canceled trial period subscription.
active	Active subscription with payment made on time.
failed	Failed subscription. bePaid was unable to process the next payment.
error	An error occurred while bePaid was attempting to process the payment.
canceled	Subscription has been canceled and is no longer active.

## **Recurring Payments** You can also set up a subscription system **without creating a plan** in your **bePaid** account. For this, you will need the customer’s **card token**. To obtain the card token, the customer must make an initial payment using a link generated via **payment\_sum**. Before setting the **payment\_sum** value, set the **bepaid\_contract** variable to specify the purpose of future payments by token: * **“recurring”** – for regular payments with a set frequency * **“card\_on\_file”** – for one-time or irregular payments, e.g., post-payment for a service {% hint style="warning" %} The **“card\_on\_file”** option is not supported by all acquirers. If you want to use it, please contact your account manager. {% endhint %} After a successful payment, the **bepaid\_client\_card\_token** variable will be added to the deal, storing the customer’s card token. This token allows you to charge the customer’s card **without their involvement**. Next, set up your funnel and specify a date or condition for automatic charging, then call the **make\_bepaid\_token\_payment** function, passing the required parameters. Parameter order:\ **amount → currency → description → contract** ### Parameter Descriptions


amount (required)	Payment amount – expected value is an integer or decimal number, for example: 100 or 100.5.
currency (required)	Payment currency in ISO 4217 format, for example: “USD”.
description (required)	Description of the charge, for example: “Weekly subscription payment for participation in the hobby club”.
contract (required)	Payment purpose by token. Expected values: “recurring” or “card_on_file”.

{% hint style="warning" %} The **contract** value must **exactly match** the value specified when creating the initial payment link! {% endhint %} If the payment is successful, the function will return the message **“Successful charge via bePaid token”**, you will receive a callback for the successful payment, and the deal variable **bepaid\_token\_payment\_completed** will be set to **“True”**. If the payment fails, the function will return a message indicating the reason for the failed payment, a callback with the suffix **“\_fail”** will be sent to the bot, and the deal variable **bepaid\_token\_payment\_completed** will be set to **“False”**. {% hint style="warning" %} The bank may require the customer to complete the payment. In this case, the function will return a link prompting the customer to go through **3-D Secure authentication**. {% endhint %} ## **How to Handle the Result** In response to customer actions, the bot will receive callbacks consisting of the **first 20 characters of the secret key** and a suffix, which depends on the type and outcome of the operation. In the system, the callback appears as a message from the user, but the user **does not see it**. ### **For Payments** For payments **not related to subscriptions**, you will receive one of the following messages: * **keyNumber\_success** – for a successful payment * **keyNumber\_fail** – for a failed payment You can also track the status of the last payment using the variables: * **bepaid\_payment\_completed** – for payments involving the customer * **bepaid\_token\_payment\_completed** – for **card token-based automatic payments** ### **For Subscriptions** After a subscription is successfully activated, either on the first or a recurring payment, the bot will receive the message **keyNumber\_success**. If the subscription is canceled, you will receive **keyNumber\_canceled**. In the case of a failed subscription payment, the message **keyNumber\_fail** will be sent. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.mavibot.ai/integrations/payment/bepaid.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.