Iegūt maksājumu sarakstu

GET/api/crm/v2/paymentsv2

operationId: payments.default

Autorizācija

api-token + language + role

Vaicājuma parametri

paymentstringobligāts

Piemērs: plastic_card

Atbildes

object

statusstringobligāts

Vērtības:successerror

Piemērs: success

dataobject

filtersobject

paymentobject (FilterEnum)

Filtrs-enums — plakans uzskaitījuma vērtību saraksts

valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of string

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

auto_paymentobject

Tikai automātiskā maksājuma gadījumā

idintegerobligāts

Piemērs: 1

card_idstringobligāts

Piemērs: 78787878

sumintegerobligāts

Piemērs: 20

payment_option_idintegerobligāts

Piemērs: 23

currency_codestringobligāts

Piemērs: RUB

amountstringobligāts

Piemērs: 1

Viens no variantiem

object

Konvertējot

conversion_payment_sumnumberobligāts

Piemērs: 20

conversion_payment_currency_codestringobligāts

Piemērs: RUB

listarray of object

option_idintegerobligāts

Piemērs: 23

namestringobligāts

Piemērs: Visa / MasterCard / MIR

system_methodstringobligāts

Piemērs: plastic_card

recurrentbooleanobligāts

Piemērs: true

name_gatewaystringobligāts

Piemērs: Example Bank

system_namestring

Piemērs: Tinkoff

payment_settings_idinteger

Maksājumu vārtejas iestatījumi valūtai; tiek atgriezts payments.add_transaction

Piemērs: 12

currency_codestring

Piemērs: RUB

is_nativeboolean

Piemērs: true

minimum_sum_multiplierinteger

Piemērs: 1

conversion_paymentstring

Piemērs: 1

payment_infoobject

payment_idintegerobligāts

Piemērs: 1

system_namestringobligāts

Piemērs: tbank

min_sum_for_paynumber

Piemērs: 600

short_textstring

Piemērs: ₽

test_accountboolean

Piemērs: 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' => 'lv', '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": "lv", "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": "lv", "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 } }