Ottenere l'elenco dei pagamenti

GET/api/crm/v2/paymentsv2

operationId: payments.default

Autorizzazione

api-token + language + role

Parametri della richiesta

paymentstringobbligatorio

Esempio: plastic_card

Risposte

object

statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject

filtersobject

paymentobject (FilterEnum)

Filtro enumerazione: elenco piatto di valori enumerati

valuestring

Esempio: example

typestringobbligatorio

Esempio: select

optionarray of string

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

auto_paymentobject

Solo per il pagamento automatico

idintegerobbligatorio

Esempio: 1

card_idstringobbligatorio

Esempio: 78787878

sumintegerobbligatorio

Esempio: 20

payment_option_idintegerobbligatorio

Esempio: 23

currency_codestringobbligatorio

Esempio: RUB

amountstringobbligatorio

Esempio: 1

Una delle opzioni

object

Durante la conversione

conversion_payment_sumnumberobbligatorio

Esempio: 20

conversion_payment_currency_codestringobbligatorio

Esempio: RUB

listarray of object

option_idintegerobbligatorio

Esempio: 23

namestringobbligatorio

Esempio: Visa / MasterCard / MIR

system_methodstringobbligatorio

Esempio: plastic_card

recurrentbooleanobbligatorio

Esempio: true

name_gatewaystringobbligatorio

Esempio: Example Bank

system_namestring

Esempio: Tinkoff

payment_settings_idinteger

Configurazione del gateway di pagamento per la valuta; restituito in payments.add_transaction

Esempio: 12

currency_codestring

Esempio: RUB

is_nativeboolean

Esempio: true

minimum_sum_multiplierinteger

Esempio: 1

conversion_paymentstring

Esempio: 1

payment_infoobject

payment_idintegerobbligatorio

Esempio: 1

system_namestringobbligatorio

Esempio: tbank

min_sum_for_paynumber

Esempio: 600

short_textstring

Esempio: ₽

test_accountboolean

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