Zahlungssystem-Einstellungen abrufen

GET/api/crm/v2/integration_paymentsv2

operationId: integrationPayments.default

Autorisierung

api-token + language + role

Abfrageparameter

branch_idinteger

Beispiel: 8920

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

settingsobject

only_prepaymentstring

Werte:noallcourierpickup

Beispiel: no

cashstring

Wird angezeigt, wenn only_prepayment ungleich all ist

Werte:noallcourierpickup

Beispiel: no

pos_terminalstring

Wird angezeigt, wenn only_prepayment ungleich all ist

Werte:noallcourierpickup

Beispiel: no

rulesstring

Zahlungsregeln im HTML

Beispiel: <h2>Payment rules<h2>

listarray of object

idintegererforderlich

Beispiel: 1

namestring

Beispiel: Revolut

payment_idintegererforderlich

Beispiel: 7160

work_modestringerforderlich

Werte:realtest

Beispiel: test

delivery_methodstringerforderlich

Werte:allcourierpickup

Beispiel: all

ffd_versionstring

Nur für Russland

Werte:1.051.2

Beispiel: 1.05

url_idinteger

Beispiel: 1

apple_pay_certificate_idinteger

Beispiel: 1

custom_certificate_idinteger

Beispiel: 1

publishedboolean

Beispiel: true

sortinteger

Beispiel: 25

payment_optionsarray of object

idintegererforderlich

Beispiel: 1

namestringerforderlich

Beispiel: Qiwi

payment_idintegererforderlich

Beispiel: 1

typestringerforderlich

Werte:onlineapple_paygoogle_pay

Beispiel: online

checkedbooleanerforderlich

Beispiel: true

payment_infoobject

namestringerforderlich

Beispiel: PayKeeper

system_namestring

Beispiel: pay_keeper

wikistring

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

certificate_requiredbooleanerforderlich

Beispiel: true

firms_show_options_rowbooleanerforderlich

Beispiel: true

webhook_setup_enabledboolean

Beispiel: true

name_with_descriptionstringerforderlich

Beispiel: PayKeeper

fieldsarray of object

encryptedbooleanerforderlich

Verschlüsseltes Feld; für die Eingabe ein Passwortfeld verwenden

Beispiel: true

namestringerforderlich

Beispiel: server

valuestring

Beispiel: d34.paykeeper.ru

regexstring

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

test_urlstring

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

work_urlarray of object

idintegererforderlich

Beispiel: 0

namestringerforderlich

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