Retrieve a list of payments

GET/api/crm/v2/paymentsv2

operationId: payments.default

Authorization

api-token + language + role

Query parameters

paymentstringrequired

Example: plastic_card

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

filtersobject

paymentobject (FilterEnum)

Filter enumeration — a flat list of enumeration values

valuestring

Example: example

typestringrequired

Example: select

optionarray of string

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

auto_paymentobject

Only for auto payment

idintegerrequired

Example: 1

card_idstringrequired

Example: 78787878

sumintegerrequired

Example: 20

payment_option_idintegerrequired

Example: 23

currency_codestringrequired

Example: RUB

amountstringrequired

Example: 1

One of the options

object

When converting

conversion_payment_sumnumberrequired

Example: 20

conversion_payment_currency_codestringrequired

Example: RUB

listarray of object

option_idintegerrequired

Example: 23

namestringrequired

Example: Visa / MasterCard / MIR

system_methodstringrequired

Example: plastic_card

recurrentbooleanrequired

Example: true

name_gatewaystringrequired

Example: Example Bank

system_namestring

Example: Tinkoff

payment_settings_idinteger

Payment gateway settings for the currency; returned in payments.add_transaction

Example: 12

currency_codestring

Example: RUB

is_nativeboolean

Example: true

minimum_sum_multiplierinteger

Example: 1

conversion_paymentstring

Example: 1

payment_infoobject

payment_idintegerrequired

Example: 1

system_namestringrequired

Example: tbank

min_sum_for_paynumber

Example: 600

short_textstring

Example: ₽

test_accountboolean

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