Pobierz listę płatności

GET/api/crm/v2/paymentsv2

operationId: payments.default

Autoryzacja

api-token + language + role

Parametry zapytania

paymentstringwymagane

Przykład: plastic_card

Odpowiedzi

object

statusstringwymagane

Wartości:successerror

Przykład: success

dataobject

filtersobject

paymentobject (FilterEnum)

Filtr-wyliczenie — płaska lista wartości wyliczenia

valuestring

Przykład: example

typestringwymagane

Przykład: select

optionarray of string

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

auto_paymentobject

Tylko przy płatności automatycznej

idintegerwymagane

Przykład: 1

card_idstringwymagane

Przykład: 78787878

sumintegerwymagane

Przykład: 20

payment_option_idintegerwymagane

Przykład: 23

currency_codestringwymagane

Przykład: RUB

amountstringwymagane

Przykład: 1

Jeden z wariantów

object

Podczas konwersji

conversion_payment_sumnumberwymagane

Przykład: 20

conversion_payment_currency_codestringwymagane

Przykład: RUB

listarray of object

option_idintegerwymagane

Przykład: 23

namestringwymagane

Przykład: Visa / MasterCard / MIR

system_methodstringwymagane

Przykład: plastic_card

recurrentbooleanwymagane

Przykład: true

name_gatewaystringwymagane

Przykład: Example Bank

system_namestring

Przykład: Tinkoff

payment_settings_idinteger

Konfiguracja bramki płatniczej dla waluty; przekazywana z powrotem w payments.add_transaction

Przykład: 12

currency_codestring

Przykład: RUB

is_nativeboolean

Przykład: true

minimum_sum_multiplierinteger

Przykład: 1

conversion_paymentstring

Przykład: 1

payment_infoobject

payment_idintegerwymagane

Przykład: 1

system_namestringwymagane

Przykład: tbank

min_sum_for_paynumber

Przykład: 600

short_textstring

Przykład: ₽

test_accountboolean

Przykład: 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' => 'pl', '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": "pl", "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": "pl", "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 } }