Obtener la lista de pagos

GET/api/crm/v2/paymentsv2

operationId: payments.default

Autorización

api-token + language + role

Parámetros de consulta

paymentstringobligatorio

Ejemplo: plastic_card

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

filtersobject

paymentobject (FilterEnum)

Filtro-enumeración: una lista plana de valores de enumeración

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of string

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

auto_paymentobject

Solo para pagos automáticos

idintegerobligatorio

Ejemplo: 1

card_idstringobligatorio

Ejemplo: 78787878

sumintegerobligatorio

Ejemplo: 20

payment_option_idintegerobligatorio

Ejemplo: 23

currency_codestringobligatorio

Ejemplo: RUB

amountstringobligatorio

Ejemplo: 1

Una de las opciones

object

Al convertir

conversion_payment_sumnumberobligatorio

Ejemplo: 20

conversion_payment_currency_codestringobligatorio

Ejemplo: RUB

listarray of object

option_idintegerobligatorio

Ejemplo: 23

namestringobligatorio

Ejemplo: Visa / MasterCard / MIR

system_methodstringobligatorio

Ejemplo: plastic_card

recurrentbooleanobligatorio

Ejemplo: true

name_gatewaystringobligatorio

Ejemplo: Example Bank

system_namestring

Ejemplo: Tinkoff

payment_settings_idinteger

Configuración de la pasarela de pago para la moneda; se devuelve en payments.add_transaction

Ejemplo: 12

currency_codestring

Ejemplo: RUB

is_nativeboolean

Ejemplo: true

minimum_sum_multiplierinteger

Ejemplo: 1

conversion_paymentstring

Ejemplo: 1

payment_infoobject

payment_idintegerobligatorio

Ejemplo: 1

system_namestringobligatorio

Ejemplo: tbank

min_sum_for_paynumber

Ejemplo: 600

short_textstring

Ejemplo: ₽

test_accountboolean

Ejemplo: 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' => 'es', '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": "es", "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": "es", "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 } }