Zahlungsliste abrufen

GET/api/crm/v2/paymentsv2

operationId: payments.default

Autorisierung

api-token + language + role

Abfrageparameter

paymentstringerforderlich

Beispiel: plastic_card

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

filtersobject

paymentobject (FilterEnum)

Filter-Enum — flache Liste von Enumerationswerten

valuestring

Beispiel: example

typestringerforderlich

Beispiel: select

optionarray of string

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

auto_paymentobject

Nur bei automatischer Zahlung

idintegererforderlich

Beispiel: 1

card_idstringerforderlich

Beispiel: 78787878

sumintegererforderlich

Beispiel: 20

payment_option_idintegererforderlich

Beispiel: 23

currency_codestringerforderlich

Beispiel: RUB

amountstringerforderlich

Beispiel: 1

Eine der Optionen

object

Bei der Konvertierung

conversion_payment_sumnumbererforderlich

Beispiel: 20

conversion_payment_currency_codestringerforderlich

Beispiel: RUB

listarray of object

option_idintegererforderlich

Beispiel: 23

namestringerforderlich

Beispiel: Visa / MasterCard / MIR

system_methodstringerforderlich

Beispiel: plastic_card

recurrentbooleanerforderlich

Beispiel: true

name_gatewaystringerforderlich

Beispiel: Example Bank

system_namestring

Beispiel: Tinkoff

payment_settings_idinteger

Zahlungsgateway-Einstellung für die Währung; wird in payments.add_transaction zurückgegeben

Beispiel: 12

currency_codestring

Beispiel: RUB

is_nativeboolean

Beispiel: true

minimum_sum_multiplierinteger

Beispiel: 1

conversion_paymentstring

Beispiel: 1

payment_infoobject

payment_idintegererforderlich

Beispiel: 1

system_namestringerforderlich

Beispiel: tbank

min_sum_for_paynumber

Beispiel: 600

short_textstring

Beispiel: ₽

test_accountboolean

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