Получить настройки платёжных систем

GET/api/crm/v2/integration_paymentsv2

operationId: integrationPayments.default

Авторизация

api-token + language + role

Параметры запроса

branch_idinteger

Пример: 8920

Ответы

object

statusstringобязательный

Значения:successerror

Пример: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Пример: 8920

typestringобязательный

Пример: select

optionarray of object

valueintegerобязательный

Пример: 8920

namestringобязательный

Пример: Green Basket | Kaliningrad

modestring (FilterMode)

Как интерфейс обрабатывает фильтр; у обычного фильтра mode нет. force_shown — всегда показан, скрыть нельзя. value_required — точка входа в раздел: всегда показан, не имеет пустого значения (пока значение не выбрано, список пуст; варианта «все» нет), общий сброс его не очищает.

Значения:force_shownvalue_required

Пример: value_required

settingsobject

only_prepaymentstring

Значения:noallcourierpickup

Пример: no

cashstring

Отображается, если only_prepayment не равно all

Значения:noallcourierpickup

Пример: no

pos_terminalstring

Отображается, если only_prepayment не равно all

Значения:noallcourierpickup

Пример: no

rulesstring

Правила оплаты в HTML

Пример: <h2>Payment rules<h2>

listarray of object

idintegerобязательный

Пример: 1

namestring

Пример: Revolut

payment_idintegerобязательный

Пример: 7160

work_modestringобязательный

Значения:realtest

Пример: test

delivery_methodstringобязательный

Значения:allcourierpickup

Пример: all

ffd_versionstring

Только для России

Значения:1.051.2

Пример: 1.05

url_idinteger

Пример: 1

apple_pay_certificate_idinteger

Пример: 1

custom_certificate_idinteger

Пример: 1

publishedboolean

Пример: true

sortinteger

Пример: 25

payment_optionsarray of object

idintegerобязательный

Пример: 1

namestringобязательный

Пример: Qiwi

payment_idintegerобязательный

Пример: 1

typestringобязательный

Значения:onlineapple_paygoogle_pay

Пример: online

checkedbooleanобязательный

Пример: true

payment_infoobject

namestringобязательный

Пример: PayKeeper

system_namestring

Пример: pay_keeper

wikistring

Пример: https://wiki.foodsoul.pro/i/68

certificate_requiredbooleanобязательный

Пример: true

firms_show_options_rowbooleanобязательный

Пример: true

webhook_setup_enabledboolean

Пример: true

name_with_descriptionstringобязательный

Пример: PayKeeper

fieldsarray of object

encryptedbooleanобязательный

Зашифрованное поле; для ввода используйте поле типа «пароль»

Пример: true

namestringобязательный

Пример: server

valuestring

Пример: d34.paykeeper.ru

regexstring

Пример: ^[0-9a-zA-Z-\\.]{1,}\\.paykeeper\\.ru$

test_urlstring

Пример: https://securepay.tinkoff.ru/v2

work_urlarray of object

idintegerобязательный

Пример: 0

namestringобязательный

Пример: securepay.tinkoff.ru

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/integration_payments', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'ru', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/integration_payments", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/integration_payments", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" } }, "settings": { "only_prepayment": "no", "cash": "no", "pos_terminal": "no" }, "rules": "<h2>Payment rules<h2>", "list": [ { "id": 1, "name": "Revolut", "payment_id": 7160, "work_mode": "test", "delivery_method": "all", "ffd_version": "1.05", "url_id": 1, "apple_pay_certificate_id": 1, "custom_certificate_id": 1, "published": true, "sort": 25, "payment_options": [ { "id": 1, "name": "Qiwi", "payment_id": 1, "type": "online", "checked": true } ], "payment_info": { "name": "PayKeeper", "system_name": "pay_keeper", "wiki": "https://wiki.foodsoul.pro/i/68", "certificate_required": true, "firms_show_options_row": true, "webhook_setup_enabled": true, "name_with_description": "PayKeeper", "fields": [ {} ], "test_url": "https://securepay.tinkoff.ru/v2", "work_url": [ {} ] } } ] } }