Získat seznam plateb

GET/api/crm/v2/paymentsv2

operationId: payments.default

Autorizace

api-token + language + role

Parametry dotazu

paymentstringpovinné

Příklad: plastic_card

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject

filtersobject

paymentobject (FilterEnum)

Filtr-enum — plochý seznam hodnot výčtu

valuestring

Příklad: example

typestringpovinné

Příklad: select

optionarray of string

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

auto_paymentobject

Pouze při automatické platbě

idintegerpovinné

Příklad: 1

card_idstringpovinné

Příklad: 78787878

sumintegerpovinné

Příklad: 20

payment_option_idintegerpovinné

Příklad: 23

currency_codestringpovinné

Příklad: RUB

amountstringpovinné

Příklad: 1

Jedna z možností

object

Při převodu

conversion_payment_sumnumberpovinné

Příklad: 20

conversion_payment_currency_codestringpovinné

Příklad: RUB

listarray of object

option_idintegerpovinné

Příklad: 23

namestringpovinné

Příklad: Visa / MasterCard / MIR

system_methodstringpovinné

Příklad: plastic_card

recurrentbooleanpovinné

Příklad: true

name_gatewaystringpovinné

Příklad: Example Bank

system_namestring

Příklad: Tinkoff

payment_settings_idinteger

Nastavení platební brány pro měnu; předává se zpět v payments.add_transaction

Příklad: 12

currency_codestring

Příklad: RUB

is_nativeboolean

Příklad: true

minimum_sum_multiplierinteger

Příklad: 1

conversion_paymentstring

Příklad: 1

payment_infoobject

payment_idintegerpovinné

Příklad: 1

system_namestringpovinné

Příklad: tbank

min_sum_for_paynumber

Příklad: 600

short_textstring

Příklad: ₽

test_accountboolean

Příklad: 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' => 'cs', '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": "cs", "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": "cs", "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 } }