Prodamus Payform Integrations

https://help.prodamus.ru/payform/integracii/
Admin
Prodamus Payform Integrations provides documentation and resources for connecting Prodamus payment...
Tokens:79,014
Snippets:468
Trust Score:9.2
Update:9 months ago
Show doc for...
Tokens:
Raw
### Install Prodamus Widget on Webpage (HTML)

Source: https://help.prodamus.ru/payform/integracii/cms/vidzhet-i-primery-knopok-dlya-saita

To integrate the Prodamus widget, insert a script tag before the closing </body> tag on your webpage. This script loads the necessary widget functionality. Ensure you replace 'yourdomain' with your actual Prodamus domain.

```html
<script type="text/javascript" src="https://yourdomain.payform.ru/widget.js" async></script>
```

```html
<script type="text/javascript" src="https://yourdomain.prodamus.me/widget.js" async></script>
```

```html
<script type="text/javascript" src="https://pay.yourdomain.ru/widget.js" async></script>
```

```html
<script type="text/javascript" src="https://payform.prodamus.me/widget.js" async></script>
```

--------------------------------

### Prodamus Payment Initialization with Customer Details (JavaScript)

Source: https://help.prodamus.ru/payform/integracii/integraciya-eo-v-konstruktory-saitov

This example shows how to enhance the payformInit function by including customer email and phone number. This data can be pre-filled, otherwise, the widget will prompt the user for it. Ensure 'UNIQ_ID' and 'XXX.payform.ru' are correctly substituted.

```javascript
const UNIQ_IDButton = document.querySelector("#UNIQ_ID");
UNIQ_IDButton?.addEventListener("click", () => {
    payformInit("XXX.payform.ru", {
        order_sum: 100,
        currency: "rub",
        customer_email: "<test@mail.ru>",
        customer_phone: "+79994478937"
    });
});
```

--------------------------------

### GET /websites/help_prodamus_ru_payform_integracii

Source: https://help.prodamus.ru/payform/integracii/rest-api/instrukcii-dlya-samostoyatelnaya-integracii-servisov

Retrieves information about payment limits for a generated link.

```APIDOC
## GET /websites/help_prodamus_ru_payform_integracii

### Description
This endpoint retrieves the payment limit associated with a generated payment link.

### Method
GET

### Endpoint
/websites/help_prodamus_ru_payform_integracii

### Parameters
#### Query Parameters
- **payments_limit** (integer) - Optional - The payment limit for the generated link.

### Response
#### Success Response (200)
- **payments_limit** (integer) - The limit of payments for the generated link.

#### Response Example
{
  "payments_limit": 100
}
```

--------------------------------

### Include Prodamus Scripts and Styles

Source: https://help.prodamus.ru/payform/integracii/integraciya-eo-v-konstruktory-saitov/veb-stranica

Add these script tags and the link tag before the closing </head> tag to initialize the Prodamus widget. Configure the `window.prodamusDomain` with your payform URL and `window.prodamusCurrency` with the desired currency code.

```jsx
<script>
  window.prodamusDomain = 'PAYFORM'; // Replace with your payform URL like myname.payform.ru
  window.prodamusCurrency = 'rub'; // Replace with 'usd', 'eur', or 'kzt' if needed
</script>
<script src="https://widget.prodamus.ru/src/init.js" async></script>
<link rel="stylesheet" href="https://widget.prodamus.ru/src/init.css">
```

--------------------------------

### Trigger Prodamus Payment Form with HTML Elements (HTML)

Source: https://help.prodamus.ru/payform/integracii/cms/vidzhet-i-primery-knopok-dlya-saita

To initiate the Prodamus payment form, assign the class 'Prodamus-startPay' to any clickable HTML element on your landing page. This allows users to easily start the payment process by interacting with these elements.

```html
<a href="#" class="Prodamus-startPay">Оплатить онлайн</a>
```

```html
<button class="Prodamus-startPay">Оплатить онлайн</button>
```

```html
<img src="img.png" class="Prodamus-startPay" />
```

```html
<div class="Prodamus-startPay">Оплатить онлайн</div>
```

--------------------------------

### Payment Processing with Demo Mode

Source: https://help.prodamus.ru/payform/integracii/rest-api/instrukcii-dlya-samostoyatelnaya-integracii-servisov

This section details how to process payments and utilize the demo mode feature for testing.

```APIDOC
## POST /payform/integration

### Description
This endpoint allows for processing payments and supports a demo mode for testing purposes.

### Method
POST

### Endpoint
/payform/integration

### Parameters
#### Request Body
- **demo_mode** (integer) - Optional - If set to 1, the payment will be processed in demo mode.

### Request Example
```json
{
  "demo_mode": 1
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the payment (e.g., "success", "failed").
- **transaction_id** (string) - The unique identifier for the transaction.

#### Response Example
```json
{
  "status": "success",
  "transaction_id": "txn_12345abcde"
}
```
```

--------------------------------

### Get Available Payment Methods

Source: https://help.prodamus.ru/payform/integracii/rest-api/instrukcii-dlya-samostoyatelnaya-integracii-servisov

Retrieves a list of available payment methods. Supports filtering by specific payment methods.

```APIDOC
## GET /websites/help_prodamus_ru_payform_integracii/available_payment_methods

### Description
Retrieves a list of available payment methods. You can filter this list by providing a comma-separated string of desired payment method codes.

### Method
GET

### Endpoint
`/websites/help_prodamus_ru_payform_integracii/available_payment_methods`

### Parameters
#### Query Parameters
- **available_payment_methods** (string) - Optional - A pipe-separated string of payment method codes to filter the results. If no methods remain after filtering, the full list will be returned.

### Request Example
```
GET /websites/help_prodamus_ru_payform_integracii/available_payment_methods?available_payment_methods=card|cash
```

### Response
#### Success Response (200)
- **available_payment_methods** (array) - A list of available payment method objects.

#### Response Example
```json
{
  "available_payment_methods": [
    {
      "code": "card",
      "name": "Bank Card"
    },
    {
      "code": "cash",
      "name": "Cash"
    }
  ]
}
```
```

--------------------------------

### Get Payment Currency Information

Source: https://help.prodamus.ru/payform/integracii/rest-api/instrukcii-dlya-samostoyatelnaya-integracii-servisov

Retrieves information about the available payment currencies. This includes the currency code and a description of accepted values.

```APIDOC
## GET /websites/help_prodamus_ru_payform_integracii/currency

### Description
Retrieves information about the available payment currencies, including their codes and accepted values.

### Method
GET

### Endpoint
/websites/help_prodamus_ru_payform_integracii/currency

### Parameters
#### Query Parameters
- **currency** (string) - Optional - The currency code to filter by. Possible values: rub, usd, eur, kzt. Parameter must be in lowercase.

### Request Example
```json
{
  "currency": "rub"
}
```

### Response
#### Success Response (200)
- **currency** (string) - The currency code (e.g., "rub").
- **description** (string) - A description of the currency and accepted values.

#### Response Example
```json
{
  "currency": "rub",
  "description": "<p>Payment currency. Possible values:</p><p>rub</p><p>usd</p><p>eur<br>kzt<br>P.S. The parameter must be in lowercase.</p>"
}
```
```

--------------------------------

### Payment Link Generation

Source: https://help.prodamus.ru/payform/integracii/rest-api/instrukcii-dlya-samostoyatelnaya-integracii-servisov

Instructions on how to generate payment links, including optional parameters like `customer_phone`.

```APIDOC
## Payment Link Generation

### Description
This section explains how to generate payment links for customer transactions. The `customer_phone` parameter is optional when creating a payment link, allowing the customer to enter it on the payment page. If provided during link generation, the customer bypasses the phone entry step.

### Method
N/A (Link Generation)

### Endpoint
N/A (Link Generation)

### Parameters
#### Query Parameters
- **do** (string) - Optional - Specifies the action, e.g., `link` to return a text link.
- **customer_phone** (string) - Optional - The customer's phone number. If omitted, the customer will be prompted to enter it.
- **urlReturn** (string) - Optional - The URL to redirect the user to after payment if not handled by Prodamus.
- **urlSuccess** (string) - Optional - The URL to redirect the user to upon successful payment if not handled by Prodamus.
- **subscription** (object) - Optional - Subscription details. If provided, `products` are ignored.
- **products** (array) - Optional - Details of the products being purchased. Ignored if `subscription` is present.
  - **price** (number) - Required - The price of the product.
  - **quantity** (number) - Required - The quantity of the product.
  - **name** (string) - Required - The name of the product.
- **customer_extra** (string) - Optional - Additional customer information.
- **order_id** (string) - Optional - A unique identifier for the order.

### Request Example
```
https://demo.payform.ru/?order_id=test&customer_phone=79998887755&products[0][price]=2000&products[0][quantity]=1&products[0][name]=Обучающие материалы&customer_extra=Полная оплата курса&do=pay
```

### Response
#### Success Response (200)
- **link** (string) - The generated payment link (when `do=link`).

#### Response Example
```json
{
  "link": "https://payform.ru/u8zDE/"
}
```
```

--------------------------------

### Webhook Notification Payload Example

Source: https://help.prodamus.ru/payform/integracii/tekhnicheskaya-dokumentaciya-po-avtoplatezham/uvedomleniya-pri-avtospisanii

Пример структуры данных, отправляемых в виде веб-хука при автосписании. Содержит информацию о заказе, сумме, клиенте и деталях подписки.

```php
array (
  'date' => '2020-07-27T12:36:02+03:00',
  'order_id' => '300169',
  'order_num' => '',
  'domain' => 'demo.payform.ru',
  'sum' => '100.00',
  'customer_phone' => '+79999999999',
  'customer_email' => 'test@domain.ru',
  'customer_extra' => '',
  'payment_type' => 'Автоплатеж',
  'attempt' => '1',
  'commission' => '3.9',
  'commission_sum' => '0.04',
  'discount_value' => '0.00',
  'subscription' => 
  array (
    'type' => 'action',
    'action_code' => 'auto_payment',
    'payment_date' => '2020-07-27 12:35',
    'id' => '593600',
    'active' => '1',
    'active_manager' => '1',
    'active_user' => '1',
    'cost' => '100.00',
    'name' => 'Доступ в клуб "Девелопер клаб" – тестовая подписка',
    'limit_autopayments' => '',
    'autopayments_num' => '1',
    'first_payment_discount' => '0.00',
    'next_payment_discount' => '0.00',
    'next_payment_discount_num' => '',
    'date_create' => '2020-07-23 20:38:57',
    'date_first_payment' => '2020-06-27 20:38:57',
    'date_last_payment' => '2020-07-27 12:35:08',
    'date_next_payment' => '2020-08-25 12:30:37',
    'date_next_payment_discount' => '2020-07-23 20:38:57',
    'current_attempt' => '1',
    'payment_num' => '2',
    'autopayment' => '1',
  ),
)
```

--------------------------------

### Initialize Prodamus Payment Widget on Button Click (JavaScript)

Source: https://help.prodamus.ru/payform/integracii/integraciya-eo-v-konstruktory-saitov

This JavaScript code should be added to your website's body. It listens for a click event on a payment button (identified by a unique ID) and calls the payformInit function to start the payment process. Replace 'UNIQ_ID' with your button's actual ID and 'XXX.payform.ru' with your Prodamus payment page URL.

```javascript
const UNIQ_IDButton = document.querySelector("#UNIQ_ID");
UNIQ_IDButton?.addEventListener("click", () => {
    payformInit("XXX.payform.ru", {
        order_sum: 100,
        currency: "rub"
    });
});
```

--------------------------------

### Configure Payment Buttons

Source: https://help.prodamus.ru/payform/integracii/integraciya-eo-v-konstruktory-saitov/veb-stranica

Use 'button' or 'a' HTML tags for payment triggers. Set the 'data-prodamusprice' attribute to the desired amount. Optionally, specify the 'data-currency' attribute for transactions in currencies other than the default.

```html
<button data-prodamusprice="123">Buy</button>
<button data-prodamusprice="123" data-currency="kzt">Buy in KZT</button>
<a href="javascript:void(0)" data-prodamusprice="123">Buy Link</a>
```
Tokens:
Raw