Λήψη λίστας πληρωμών

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