Перейти к содержанию

Embedded checkout

z# Создайте встроенную страницу оформления заказа с индивидуальным дизайном. Версия 2.0

Вы можете разработать собственную страницу оформления заказа, размещенную на вашем веб-сайте, в виде обычного кода HTML + CSS.

Мы разработали готовый пример (HTML/CSS/JavaScript), который вы можете попробовать использовать на своем сайте:

Пример базового дизайна оформления заказа.

See the Pen Payme - custom checkout light(@payme-uz) on CodePen.

Сначала необходимо импортировать JavaScript SDK:

https://pay.payme.uz/future/checkout-vue/checkout.js

Затем файлы CSS:

https://pay.payme.uz/future/checkout-vue/checkout.css

Страница оформления заказа настроена с помощью кода JavaScript:

Пример конфигурации

var Options = {
    options: {
        methods: ['card'],
        methods_disabled: [],
        card_icons: ['humo', 'uzcard'],
        active_tab: 'card',
        fields: false,
        title: 'my_title',
        link: 'https://shop.com',
        full_screen: true,
        button: true,
        email: true
    },
    params: {
        merchant_id: 4056281,
        required_rectoken: 'y',
        currency: 'UZS',
        amount: 500,
        order_desc: 'my_order_desc',
        response_url: 'http://shop.com/thankyoupage'
    }
}
checkout("#app", Options);

Конфигурация JavaScript имеет следующую структуру:

Configuration structure

{
  options: {},
  params: {},
  button: {}, // button config 
  fields_custom: [],
  messages: {},
  css_variable: {},
}

Настройте параметры настройки формы на странице оплаты

Название параметра Тип параметра Значение по умолчанию Описание
methods Массив ['card'] поддерживает card, most_popular, banks, wallets.
methods_disabled Массив [] поддерживает card, most_popular, banks, wallets.
card_icons Массив ['humo', 'uzcard'] support mastercard, visa, humo, uzcard
banks_icons Массив []
local_methods_icons Массив []
crypto_icons Массив []
loans_icons Массив []
emoney_icons Массив []
wallets_icons Массив []
title Строка
link Строка format url
full_screen Булево true
locales Массив [все] support uz, az, cs, da, de, en, es, fi, fr, hu, it, ka, ko, lv, nl, pl, ro, ru, sk, uk, zh
api_domain Строка 'pay.payme.uz'
endpoint Объект
active_tab Строка 'card' support card, most_popular, banks, wallets
active_method Строка ''
logo_url Строка format url
offerta_url Строка format url
default_country Строка
countries Массив
theme Объект
show_menu_first Булево false
disable_request Boolean false запросы на сервер не отправляются
subscription Объект
loading Строка format url
amount_readonly Булево true
autosubmit Булево false
show_amount Булево true
show_email Булево false
show_fee Булево true
show_lang Булево true
show_link Булево true
show_order_desc Булево true
show_pay_button_amount Булево true отображение суммы на кнопке
show_pay_button Булево true
show_processed Булево true
show_secure_message Булево true
show_test_mode Булево true
show_title Булево true

options.theme

Название Тип По умолчанию Описание
type Строка 'light' support light, dark.
preset Строка 'black' support reset, black, silver, vibrant_silver, vibrant_gold, solid_black, black_and_white, euphoric_pink, heated_steel, nude_pink, tropical_gold, navy_shimmer.
layout Строка 'default' поддерживает default, plain, wallets_only.

options.subscription

Название Тип 1 По умолчанию Описание
type Строка 'disable' support disable, hidden, shown_edit_on, shown_edit_off, shown_readonly
periods Массив ['day', 'week', 'month'] поддержка day, week, month.
quantity Булево false
trial Булево false
unlimited Булево true
readonly Булево false

Параметры заказа, описанные в Параметры запроса

Название параметра Тип параметра Значение по умолчанию Описание
merchant_id Целое число 4056281
order_desc Строка
amount Integer null
currency Строка 'UZS'
response_url Строка format url
lang Строка язык браузера
required_rectoken String support Y, N, y, n.
verification String support Y, N, y, n.
token Строка длина 40
button Строка длина 20–80
offer Булево false
recurring_data Объект
custom Объект
customer_data Объект

params.recurring_data

Значения параметров подписки: период, периодичность, дата начала, дата окончания, регулярная сумма

Название Тип По умолчанию Описание
every Integer 1
period Строка 'month' поддерживает day, week, month.
amount Integer 0
end_time Строка формат ГГГГ-ММ-ДД
start_time Строка формат ГГГГ-ММ-ДД
quantity Integer 0
trial_period Строка ''
trial_quantity Integer 0

params.customer_data

Название Тип По умолчанию Описание
customer_name Строка
customer_address Строка
customer_zip Строка
customer_city Строка
customer_country Строка словарь countries
customer_state Строка
phonemobile Строка format phone
email Строка format email

Локализация сообщений

{
  messages: {
    {en}: {
      {id}: {value},
      ...
    },
    ...
  },
}
{
  css_variable: {
    main: {hex color value},
    card_bg: {hex color value},
    card_shadow: {hex color value}
  }
}       
{
  fields_custom: {
    id-1: {
      name: 'id-1',
      label: 'label1',
      value: 'value1',
      readonly: true,
      p: 1
    },
    id-2: {
      name: 'id-2',
      label: 'label2',
      value: 'value2',
      p: 2
    },
    id-3: {
      name: 'id-3',
      label: 'label3',
      type: 'checkbox',
      required: true,
      p: 3
    }
  }
}

Ниже приведены примеры готовых дизайнов страниц оплаты в различных стилях.

Пример простого дизайна оформления заказа для карт

See the Pen Payme - layout plain(@payme-uz) on CodePen.

Пример простого дизайна оформления заказа для карт с кнопкой отправки кода JS

See the Pen Payme - layout plain with submit button(@payme-uz) on CodePen.

Пример стиля: светлый фон, синяя карта

See the Pen Payme - custom checkout light(@payme-uz) on CodePen.

Пример стиля: тёмный фон, синяя карта

See the Pen Payme - custom checkout dark(@payme-uz) on CodePen.

Пример для компактного региона

С параметрами full_screen: false, hide_title: true, hide_link: true

Пример с дополнительными полями для мерчанта

See the Pen Payme - custom checkout. Additional fields. Version 2.0(@payme-uz) on CodePen.

Пример с подпиской

После первого успешного платежа платежный шлюз создаст календарь с запланированными регулярными платежами. Периодичность и частота устанавливаются в параметрах страницы оплаты.

See the Pen Payme - custom checkout. Subscription. Version 2.0(@payme-uz) on CodePen.

Пример с подпиской и локализацией пользовательских полей

See the Pen Payme - custom checkout. Subscription. Version 2.0(@payme-uz) on CodePen.

Пример обработки события нажатия кнопки оплаты

See the Pen Payme - checkout with own submit buttons. Version 2.0(@payme-uz) on CodePen.

Пример с обратными вызовами JavaScript

Вы можете перехватить значение параметра response_code и заменить сообщение кода на своё собственное. Ознакомьтесь со всеми кодами codes.

See the Pen Payme - custom checkout. Javascript calbacks. Version 2.0 by Maxim (@payme-uz) on CodePen.

Пример с заказом, созданным на бэкенде

Создайте заказ на вашем сервере:

curl -i -X POST \
 -H "Content-Type:application/json" \
 -d \
'{
  "request": {
    "server_callback_url": "http://myshop/callback/",
    "order_id": "TestOrder_JSSDK_v2",
    "currency": "UZS",
    "merchant_id": 4056281,
    "order_desc": "Test payment",
    "lifetime" : 999999,
    "amount": 1000,
    "signature": "91ea7da493a8367410fe3d7f877fb5e0ed666490"
  }
}' \
 'https://pay.payme.uz/api/checkout/token' 

Получение токена заказа:

{
  "response":{
    "response_status":"success",
    "token":"b3c178ad84446ef36eaab365b1e12e6987e9b3d9"
  }
} 

Загрузите страницу оформления заказа с токеном заказа в качестве параметра:

var Options = {
  options: {
    methods: ['card'],
    methods_disabled: [],
    card_icons: ['humo', 'uzcard'],
    active_tab: 'card',
    fields: false,
    title: 'Demo checkout',
    link: 'https://shop.com',
    full_screen: true,
    button: true,
    email: true
  },
  params: {
    token: "b3c178ad84446ef36eaab365b1e12e6987e9b3d9"
  }
}
checkout("#checkout-container", Options);

Использование цветовых пресетов и личный журнал

Вы можете использовать предустановки градиентных цветов с помощью объекта theme в разделе options.

options: {
  methods: ['card'],
  ...
  ,
  theme: {
    type: "light",
    preset: "black"
}

Атрибут type может иметь значение «light» или «dark».

Атрибут preset может принимать одно из следующих значений:

vibrant_gold
vibrant_silver
euphoric_pink
black
solid_black
silver
black_and_white
heated_steel
nude_pink
tropical_gold
navy_shimmer

Пример шаблона silver

See the Pen Payme - minimal checkout ligt euphoric_pink v2.0(@payme-uz) on CodePen.

Все названия градиентов можно сопоставить следующим образом (кликните, чтобы увеличить изображение):

Пресеты

Вы можете использовать собственные плоские цвета с помощью параметра css_variable (для его использования необходимо установить preset: "reset"), а также собственный логотип с помощью параметра logo_url:

Пример шаблона с основным цветом valencia #D94343 для фона карты и fuchsia_blue: #7054C7 для цвета кнопки

See the Pen Payme - custom colors by Maxim (@payme-uz) on CodePen.

Мы рекомендуем использовать следующие цвета:

valencia: #D94343
flame_pea: #DF583D
jaffa: #E86F33
zest: #E58626
gamboge: #EBA212
citron: #A9B221
sushi: #82B536
chelsea_cucumber: #6BA854
fruit_salad: #54A868
breaker_bay: #54A199
pelorous: #43ABBF
havelock_blue: #57A4DC
curious_blue: #4F8BE0
indigo: #6073D1
fuchsia_blue: #7054C7
studio: #8453B5
wisteria: #9D55B5
fuchsia_pink: #BA5BB2
mulberry: #C74E8A
cabaret: #D4486B