Отримати список платежів

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.pro/api/crm/v2/payments?payment=plastic_card', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'uk', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/payments?payment=plastic_card", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "uk", "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 } }