Получить список платежей

GET/api/crm/v2/paymentsv2

operationId: payments.default

Авторизация

api-token + language + role

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

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

Пример: plastic_card

Ответы

object

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

Значения:successerror

Пример: success

dataobject

filtersobject

paymentobject (FilterEnum)

Фильтр-перечисление — плоский список значений перечисления

valuestring

Пример: example

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

Пример: select

optionarray of string

modestring (FilterMode)

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

Значения:force_shownvalue_required

Пример: value_required

auto_paymentobject

Только при автоплатеже

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

Пример: 1

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

Пример: 78787878

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

Пример: 20

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

Пример: 23

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

Пример: RUB

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

Пример: 1

Один из вариантов

object

При конвертации

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

Пример: 20

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

Пример: RUB

listarray of object

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

Пример: 23

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

Пример: Visa / MasterCard / MIR

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

Пример: plastic_card

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

Пример: true

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

Пример: Example Bank

system_namestring

Пример: Tinkoff

payment_settings_idinteger

Настройка платёжного шлюза для валюты; передаётся обратно в payments.add_transaction

Пример: 12

currency_codestring

Пример: RUB

is_nativeboolean

Пример: true

minimum_sum_multiplierinteger

Пример: 1

conversion_paymentstring

Пример: 1

payment_infoobject

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

Пример: 1

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

Пример: tbank

min_sum_for_paynumber

Пример: 600

short_textstring

Пример: ₽

test_accountboolean

Пример: true

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/payments?payment=plastic_card', [ '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/payments?payment=plastic_card", { 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/payments?payment=plastic_card", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "payment": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" } }, "auto_payment": { "conversion_payment_sum": 20, "conversion_payment_currency_code": "RUB" }, "list": [ { "option_id": 23, "name": "Visa / MasterCard / MIR", "system_method": "plastic_card", "recurrent": true, "name_gateway": "Example Bank", "system_name": "Tinkoff", "payment_settings_id": 12, "currency_code": "RUB", "is_native": true, "minimum_sum_multiplier": 1, "conversion_payment": "1", "payment_info": { "payment_id": 1, "system_name": "tbank" } } ], "min_sum_for_pay": 600, "short_text": "₽", "test_account": true } }