Gauti mokėjimų sąrašą

GET/api/crm/v2/paymentsv2

operationId: payments.default

Autorizacija

api-token + language + role

Užklausos parametrai

paymentstringprivalomas

Pavyzdys: plastic_card

Atsakymai

object

statusstringprivalomas

Reikšmės:successerror

Pavyzdys: success

dataobject

filtersobject

paymentobject (FilterEnum)

Filtras-enumeracija — plokščias enumeracijos reikšmių sąrašas

valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: select

optionarray of string

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

auto_paymentobject

Tik su automatiniu mokėjimu

idintegerprivalomas

Pavyzdys: 1

card_idstringprivalomas

Pavyzdys: 78787878

sumintegerprivalomas

Pavyzdys: 20

payment_option_idintegerprivalomas

Pavyzdys: 23

currency_codestringprivalomas

Pavyzdys: RUB

amountstringprivalomas

Pavyzdys: 1

Vienas iš variantų

object

Konvertuojant

conversion_payment_sumnumberprivalomas

Pavyzdys: 20

conversion_payment_currency_codestringprivalomas

Pavyzdys: RUB

listarray of object

option_idintegerprivalomas

Pavyzdys: 23

namestringprivalomas

Pavyzdys: Visa / MasterCard / MIR

system_methodstringprivalomas

Pavyzdys: plastic_card

recurrentbooleanprivalomas

Pavyzdys: true

name_gatewaystringprivalomas

Pavyzdys: Example Bank

system_namestring

Pavyzdys: Tinkoff

payment_settings_idinteger

Mokėjimo šliuzo nustatymas valiutai; perduodama atgal į payments.add_transaction

Pavyzdys: 12

currency_codestring

Pavyzdys: RUB

is_nativeboolean

Pavyzdys: true

minimum_sum_multiplierinteger

Pavyzdys: 1

conversion_paymentstring

Pavyzdys: 1

payment_infoobject

payment_idintegerprivalomas

Pavyzdys: 1

system_namestringprivalomas

Pavyzdys: tbank

min_sum_for_paynumber

Pavyzdys: 600

short_textstring

Pavyzdys: ₽

test_accountboolean

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