CloudPayments Plugin Documentation
Initial Setup

First, you need to enter the following credentials in the plugin settings:
- publicId - Your CloudPayments public ID
- username - Same as publicId (used for API calls)
- password - Your API key (used for subscription management)

The username and password are used for API calls, particularly for subscription management.

Actions Overview

The plugin provides two main payment actions:
- CloudPayments Payment - For one-time payments
- CloudPayments Subscription - For recurring payments/subscriptions

CloudPayments Payment Action

Basic Payment Fields
- Type - Payment type (charge or auth)
- Description - Payment description
- Amount - Payment amount (number)
- Currency - Currency code (e.g., RUB, USD)
- accountId - Customer identifier
- invoiceId - Invoice/order ID (optional)
- email - Customer email (optional)
- Skin - Widget appearance (mini, classic, or modern) (optional)

Success/Fail Handling
- onSuccess - Redirection URL for successful payment
- onFail - Redirection URL for failed payment  
- onComplete - URL for payment completion webhook
- onCompleteMethod - HTTP method for completion webhook (POST/GET)

Additional Data
- data - Custom data fields for receipts or transaction export (optional)

New Payment Method Control Features

Individual Payment Method Support (Optional)
Control which payment methods are available in the widget:
- googlepaysupport - Enable/disable Google Pay
- applepaysupport - Enable/disable Apple Pay
- sbpsupport - Enable/disable SBP (Fast Payment System)
- tinkoffinstallmentsupport - Enable/disable Tinkoff installments
- tinkoffpaysupport - Enable/disable TinkoffPay
- dolyamesupport - Enable/disable Dolyame payments
- mirpaysupport - Enable/disable MirPay
- foreignsupport - Enable/disable foreign cards
- sberpaysupport - Enable/disable SberPay
- yandexpaysupport - Enable/disable Yandex Pay
- masterpasssupport - Enable/disable MasterPass
- mtspaysupport - Enable/disable MTS Pay
- speisupport - Enable/disable SPEI (Mexico)
- installmentkzsupport - Enable/disable Kazakhstan installments
- tinkoffcreditsupport - Enable/disable Tinkoff Credit

Payment Methods Ordering (Optional)
- paymentmethodsorder - Comma-separated list defining the order of payment methods
 - Available values: Card, SbpPay, SberPay, MirPay, TinkoffPay, TinkoffInstallmentPay, TinkoffCredit, ApplePay, GooglePay, YandexPay, MasterPass, MtsPay, TcsBnplDolyame, ForeignCard, Som, Spei, InstallmentKz
 - Example: Card,SbpPay,SberPay,MirPay

Display Configuration (Optional)
- paymentmethodsnotfoldedcount - Number of payment methods to show expanded (rest will be under "More")

T-Pay Redirect URLs (Optional)
- successredirecturl - Success redirect URL for T-Pay payments
- failredirecturl - Fail redirect URL for T-Pay payments

CloudPayments Subscription Action

The CloudPayments Subscription action includes all the payment action fields plus additional subscription-specific features:

Subscription-Specific Fields
- Product details - Product name, price, quantity, amount, VAT
- Receipt information - Taxation system, phone, BSO settings
- Recurrent settings - Interval, period, max periods, start date, subscription amount

Payment Method Features
The subscription action includes all the same payment method control features as the payment action:
- All 15 individual payment method support flags
- Payment methods ordering capability
- Display configuration options
- Note: T-Pay redirect URLs are not applicable for subscription payments

Usage Examples

Russian Market Configuration
foreignsupport: false
paymentmethodsorder: Card,SbpPay,SberPay,MirPay
paymentmethodsnotfoldedcount: 2

International Payments
paymentmethodsorder: ApplePay,GooglePay,Card,SbpPay
paymentmethodsnotfoldedcount: 3

Mobile-First Experience
paymentmethodsorder: ApplePay,GooglePay,YandexPay,SberPay,Card
sbpsupport: true
foreignsupport: true

Data Sources for Subscription Management

Subscriptions List
1. Action: Use "Subscriptions list Action" with customer's accountId (usually email)
2. Repeating Group: Choose "Get data from an external API" → "CloudPayments - Subscriptions List Data" → Select Model as Data Source

Transactions List
Same as subscriptions list - use "CloudPayments - Transactions List Data" as the data source.

Subscription Details
Use "CloudPayments - Subscription Details" as the Data Source for a Group element (not Repeating Group) since it returns data about a single subscription.

Widget Customization

- Language - Choose widget language
- Skin options: mini, classic, modern
- Payment method visibility - Control which methods appear
- Payment method ordering - Customize the display order
- Expanded methods count - Control how many methods show without clicking "More"

Support

For questions or suggestions, contact us at [email protected]

Technical Notes

- The plugin automatically handles CloudPayments script availability
- Supports both comma-separated and JSON array formats for payment method ordering
- All payment method control features work for both payment and subscription actions
- Error handling is built-in for invalid configurations