Ստանալ վճարումների ցանկը

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