Obter configurações dos sistemas de pagamento

GET/api/crm/v2/integration_paymentsv2

operationId: integrationPayments.default

Autorização

api-token + language + role

Parâmetros de consulta

branch_idinteger

Exemplo: 8920

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

settingsobject

only_prepaymentstring

Valores:noallcourierpickup

Exemplo: no

cashstring

Exibido se only_prepayment for diferente de all

Valores:noallcourierpickup

Exemplo: no

pos_terminalstring

Exibido se only_prepayment for diferente de all

Valores:noallcourierpickup

Exemplo: no

rulesstring

Regras de pagamento em HTML

Exemplo: <h2>Payment rules<h2>

listarray of object

idintegerobrigatório

Exemplo: 1

namestring

Exemplo: Revolut

payment_idintegerobrigatório

Exemplo: 7160

work_modestringobrigatório

Valores:realtest

Exemplo: test

delivery_methodstringobrigatório

Valores:allcourierpickup

Exemplo: all

ffd_versionstring

Apenas para a Rússia

Valores:1.051.2

Exemplo: 1.05

url_idinteger

Exemplo: 1

apple_pay_certificate_idinteger

Exemplo: 1

custom_certificate_idinteger

Exemplo: 1

publishedboolean

Exemplo: true

sortinteger

Exemplo: 25

payment_optionsarray of object

idintegerobrigatório

Exemplo: 1

namestringobrigatório

Exemplo: Qiwi

payment_idintegerobrigatório

Exemplo: 1

typestringobrigatório

Valores:onlineapple_paygoogle_pay

Exemplo: online

checkedbooleanobrigatório

Exemplo: true

payment_infoobject

namestringobrigatório

Exemplo: PayKeeper

system_namestring

Exemplo: pay_keeper

wikistring

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

certificate_requiredbooleanobrigatório

Exemplo: true

firms_show_options_rowbooleanobrigatório

Exemplo: true

webhook_setup_enabledboolean

Exemplo: true

name_with_descriptionstringobrigatório

Exemplo: PayKeeper

fieldsarray of object

encryptedbooleanobrigatório

Campo criptografado; use um campo do tipo "senha" para entrada

Exemplo: true

namestringobrigatório

Exemplo: server

valuestring

Exemplo: d34.paykeeper.ru

regexstring

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

test_urlstring

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

work_urlarray of object

idintegerobrigatório

Exemplo: 0

namestringobrigatório

Exemplo: securepay.tinkoff.ru

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

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/integration_payments", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "pt", "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": [ {} ] } } ] } }