Obtenir la liste des paiements

GET/api/crm/v2/paymentsv2

operationId: payments.default

Autorisation

api-token + language + role

Paramètres de requête

paymentstringobligatoire

Exemple: plastic_card

Réponses

object

statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject

filtersobject

paymentobject (FilterEnum)

Filtre d’énumération — liste plate de valeurs d’énumération

valuestring

Exemple: example

typestringobligatoire

Exemple: select

optionarray of string

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

auto_paymentobject

Uniquement pour le paiement automatique

idintegerobligatoire

Exemple: 1

card_idstringobligatoire

Exemple: 78787878

sumintegerobligatoire

Exemple: 20

payment_option_idintegerobligatoire

Exemple: 23

currency_codestringobligatoire

Exemple: RUB

amountstringobligatoire

Exemple: 1

L'une des options

object

Lors de la conversion

conversion_payment_sumnumberobligatoire

Exemple: 20

conversion_payment_currency_codestringobligatoire

Exemple: RUB

listarray of object

option_idintegerobligatoire

Exemple: 23

namestringobligatoire

Exemple: Visa / MasterCard / MIR

system_methodstringobligatoire

Exemple: plastic_card

recurrentbooleanobligatoire

Exemple: true

name_gatewaystringobligatoire

Exemple: Example Bank

system_namestring

Exemple: Tinkoff

payment_settings_idinteger

Configuration de la passerelle de paiement pour la devise ; renvoyé dans payments.add_transaction

Exemple: 12

currency_codestring

Exemple: RUB

is_nativeboolean

Exemple: true

minimum_sum_multiplierinteger

Exemple: 1

conversion_paymentstring

Exemple: 1

payment_infoobject

payment_idintegerobligatoire

Exemple: 1

system_namestringobligatoire

Exemple: tbank

min_sum_for_paynumber

Exemple: 600

short_textstring

Exemple: ₽

test_accountboolean

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