Төлемдер тізімін алу

GET/api/crm/v2/paymentsv2

operationId: payments.default

Авторизация

api-token + language + role

Сұраныс параметрлері

paymentstringміндетті

Мысал: plastic_card

Жауаптар

object

statusstringміндетті

Мәндер:successerror

Мысал: success

dataobject

filtersobject

paymentobject (FilterEnum)

Фильтр-тізім — enum мәндерінің жазық тізімі

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' => 'kk', '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": "kk", "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": "kk", "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 } }