Get payment system settings

GET/api/crm/v2/integration_paymentsv2

operationId: integrationPayments.default

Authorization

api-token + language + role

Query parameters

branch_idinteger

Example: 8920

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object

valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

settingsobject

only_prepaymentstring

Values:noallcourierpickup

Example: no

cashstring

Displayed if only_prepayment is not equal to all

Values:noallcourierpickup

Example: no

pos_terminalstring

Displayed if only_prepayment is not equal to all

Values:noallcourierpickup

Example: no

rulesstring

Payment rules in HTML

Example: <h2>Payment rules<h2>

listarray of object

idintegerrequired

Example: 1

namestring

Example: Revolut

payment_idintegerrequired

Example: 7160

work_modestringrequired

Values:realtest

Example: test

delivery_methodstringrequired

Values:allcourierpickup

Example: all

ffd_versionstring

Only for Russia

Values:1.051.2

Example: 1.05

url_idinteger

Example: 1

apple_pay_certificate_idinteger

Example: 1

custom_certificate_idinteger

Example: 1

publishedboolean

Example: true

sortinteger

Example: 25

payment_optionsarray of object

idintegerrequired

Example: 1

namestringrequired

Example: Qiwi

payment_idintegerrequired

Example: 1

typestringrequired

Values:onlineapple_paygoogle_pay

Example: online

checkedbooleanrequired

Example: true

payment_infoobject

namestringrequired

Example: PayKeeper

system_namestring

Example: pay_keeper

wikistring

Example: https://wiki.foodsoul.pro/i/68

certificate_requiredbooleanrequired

Example: true

firms_show_options_rowbooleanrequired

Example: true

webhook_setup_enabledboolean

Example: true

name_with_descriptionstringrequired

Example: PayKeeper

fieldsarray of object

encryptedbooleanrequired

Encrypted field; use a password-type input field for entry

Example: true

namestringrequired

Example: server

valuestring

Example: d34.paykeeper.ru

regexstring

Example: ^[0-9a-zA-Z-\\.]{1,}\\.paykeeper\\.ru$

test_urlstring

Example: https://securepay.tinkoff.ru/v2

work_urlarray of object

idintegerrequired

Example: 0

namestringrequired

Example: 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' => 'en', '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": "en", "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": "en", "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": [ {} ] } } ] } }