Создание ордера FORM

Создает форму для оплаты и возвращает ссылку.

POST /api/v1/form/create

Создание формы

При получении формы пользователь переходит на платежную форму, где выбирает метод оплаты.

На форме отображаются кнопки с выбором метода оплаты, пользователю предоставлена возможность выбрать способ оплаты самостоятельно.

Передача button_name (предвыбор кнопки)

Если нужно указать банк пользователя, необходимо передать параметр button_name. В таком случае этап с выбором метода и банка пропускается, кнопка предвыбрана при создании формы, подсказки и диплинки на форме отображаются только по указанному банку. Пользователь в таком случае сразу переходит на страницу реквизитов.

{
	"client_order_id": "test_order_123",
	"order_side": "Buy",
	"button_name": "Sberpay", // Опционально передается банк пользователя, например Сбер
	"amount": "1000", 
	"unique_amount": false,
	"user_id": "test_user123"
}

Возможные значения для поля button_name:

AlfaPay; SberPay; TPay; VTBPay

Пример запроса

curl -X POST "https://api.payscrow-cascade.io/api/v1/form/create" \
-H "Content-Type: application/json" \
-H "X-API-Key: your_api_key" \
-d '{
    "order_data": {
        "client_order_id": "test_order_123",
        "button_name": "Sberpay",
        "order_side": "Buy",
        "amount": "5543",
        "user_id": "user_123"
    },
    "redirect_url": "https://www.google.com/",
    "support_url": "https://www.google.com/"
}'

Параметры тела запроса (body)

Параметр	Тип	Описание
client_order_id	string	Уникальный идентификатор ордера в системе клиента.
order_side	enum	Тип операции ордера. В текущей версии API доступно только значение "Buy" - создание ордера на прием.
button_name	enum, nullable	Позволяет предвыбрать способ оплаты на форме. При передаче параметра этап выбора метода пропускается. При отсутствии параметра на форме будут предложены доступные платежные методы.
amount	decimal	Целевая сумма ордера (без учета комиссии сервиса).
redirect_url	url, nullable	Страница для перенаправления клиента после успешного закрытия сделки. Если оставить поле пустым - перенаправления не произойдёт
support_url	url, nullable	Ссылка, которая будет доступна пользователю для обращения к поддержке. Если оставить поле пустым, кнопка обращения в службу поддержки отображаться не будет.
user_id	string, nullable	Идентификатор пользователя для работы антифрод системы (блокирует массовые заявки от одного пользователя)
unique_amount	bool, nullable	Уникализация суммы. Для повышения конверсии при выдаче реквизитов рекомендуется передавать параметр со значением true. В этом случае будут подобраны реквизиты с суммой в диапазоне от amount до amount + 9, а новая сумма появится при созданной сделке на форме и в КБ. Настоятельно рекомендуем использовать этот параметр при запросе реквизитов на «круглые» суммы (например, 1000, 2000 и т.д.).

Пример ответа 201

{
	"success": true,
	"message": null,
	"form_data": {
		"session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
		"form_url": "https://domain.at/?session_id=3fa85f64-5717-4562-b3fc-2c963f66afa6",
		"order_data": {
			"client_order_id": "test_order_123",
			"order_side": "Buy",
			"method_id": null,
			"amount": "5543.00",
			"user_id": "user_123",
			"unique_amount": false
		},
		"support_url": "https://google.com/",
		"redirect_url": "https://google.com/"
	}
}

Описание ошибок

• 409 - На терминале не активирована платежная форма, обратитесь к администратору
• 429 - Лимит запросов / блокировка антифродом по user_id