Перелік полів за послугою


Метод

Array getBillFields( array $request );

Запит

Поле Тип Опис Статус
bill_id Integer Унікальний ідентифікатор послуги Обов'язковий
step Integer Крок Опціональний
lang String ua - Українська
en - Англійська
ru - Російська
Опціональний

Відповідь

Поля Тип Опис Статус
id Integer Унікальний ідентифікатор поля
bill_id Integer Унікальний ідентифікатор послуги
name String Назва змінної
приклад: target_fio
label Array/String Назва поля
Якщо у запиті є параметр lang, буде повернено одне значення, інакше масив
[ ua, en, ru ]
description Array/String Опис змінної
Якщо у запиті є параметр lang, буде повернено одне значення, інакше масив
[ ua, en, ru ]
placeholder Array/String Підказка поля у фоні поля
pattern String Шаблон регулярного виразу
default String Заповнене поле
drop_down_list Array Випадаючий перелік
type String Тип поля:
textInput - Текстове значення
phoneInput - Значення з телефонною маскою
dropDownList - Значення переліку
hiddenInput - Значення заховане від показу на сайті
passwordInput - Значення пароля заховано зірочками
format String Формат текстового поля:
text - Текстове значення
float - Число з рухомою комою
number - Цілочисленне значення
double - Число з рухомою комою
numeric - Числове значення
string - Текстове значення
minlength Integer Мінімальна кількість знаків для поля
maxlength Integer Максимальна кількість знаків для поля
min Integer Мінімальне значення для поля
max Integer Максимальне значення для поля
in String Місткість допустимих значень
step Integer Крок, на якому поле доступне
order Integer Сортування поля (менше значення – вище за списком)
is_required Integer 0 - Не обов'язково
1 - Обов'язково
is_active Integer 0 - Не активно
1 - Активно

Метод 1: Виклик методу PHP

Запит

$response = $api->getBillFields([ 'bill_id' => 541, 'lang' => 'ua' ]));

Відповідь

Array
(
    [response] => Array
        (
            [0] => Array
                (
                    [id] => 2
                    [bill_id] => 541
                    [name] => acc
                    [label] => Номер телефону
                    [description] => Наприклад, +380670000000
                    [description_img] => Array
                        (
                            [extension] => 
                            [base64] => 
                        )

                    [placeholder] => +380 (67) 000 00 00
                    [pattern] => ^(\+|)(380|38|80|0|)(\s\(|\(|\(0|\s\(0|)(67|96|97|98|39|68|50|75|63|66|70|90|73|91|92|93|94|95|99|75|77)(\)\s|\)|0\)|)([0-9]{7}|[0-9\s]{9})$
                    [default] => 
                    [drop_down_list] => 
                    [type] => phoneInput
                    [format] => text
                    [minlength] => 9
                    [maxlength] => 19
                    [min] => 
                    [max] => 
                    [in] => 
                    [step] => 1
                    [order] => 1
                    [is_required] => 1
                    [is_not_required] => 
                    [is_active] => 1
                )

            [1] => Array
                (
                    [id] => 3
                    [bill_id] => 541
                    [name] => invoice
                    [label] => Сума
                    [description] => Введіть суму в гривнях
                    [description_img] => Array
                        (
                            [extension] => 
                            [base64] => 
                        )

                    [placeholder] => 0.00
                    [pattern] => ^(?:[0-9]\d*)?(?:\.\d{1,2})?$
                    [default] => 60
                    [drop_down_list] => 
                    [type] => textInput
                    [format] => float
                    [minlength] => 1
                    [maxlength] => 8
                    [min] => 0
                    [max] => 3000
                    [in] => 
                    [step] => 1
                    [order] => 3
                    [is_required] => 1
                    [is_not_required] => 
                    [is_active] => 1
                )

        )

)

Метод 2: Використання запиту на URL

https://www.ipay.ua/shina/bill/fields

Запит

{
    "request":{
        "app_id":"auto_test",
        "sig":"03221e365316dc1f8b3482d194c7d1cf",
        "time":"2016-06-14 16:56:46",
        "bill_id":541
    }
}

Відповідь

{
    "response":[
        {
            "id":2,
            "bill_id":541,
            "name":"acc",
            "label":{
                "ru":"Номер телефона",
                "ua":"Номер телефону",
                "en":"Phone number"
            },
            "description":{
                "ru":"Например, +380670000000",
                "ua":"Наприклад, +380670000000",
                "en":"For example +380670000000"
            },
            "placeholder":"+380 (67) 000 00 00",
            "pattern":"^([\\+])??(380)??\\s??\\((67|96|97|98|39|68)\\)\\s??([0-9\\s]){9}$",
            "default":null,
            "drop_down_list":null,
            "type":"phoneInput",
            "format":"text",
            "minlength":10,
            "maxlength":19,
            "min":null,
            "max":null,
            "in":null,
            "step":1,
            "order":2,
            "is_required":1,
            "is_active":1
        },
        {
            "id":3,
            "bill_id":541,
            "name":"invoice",
            "label":{
                "ru":"Сумма",
                "ua":"Сумма",
                "en":"Amount"
            },
            "description":{
                "ru":"Введите сумму в гривнах",
                "ua":"Введіть суму в гривнях",
                "en":"Enter the amount in UAH"
            },
            "placeholder":"0.00",
            "pattern":"^(?:[0-9]\\d*)?(?:\\.\\d{2})?$",
            "default":"40",
            "drop_down_list":null,
            "type":"textInput",
            "format":"float",
            "minlength":1,
            "maxlength":8,
            "min":1,
            "max":1500,
            "in":null,
            "step":1,
            "order":3,
            "is_required":1,
            "is_active":1
        }
    ]
}