Obter a lista de pagamentos

GET/api/crm/v2/paymentsv2

operationId: payments.default

Autorização

api-token + language + role

Parâmetros de consulta

paymentstringobrigatório

Exemplo: plastic_card

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

filtersobject

paymentobject (FilterEnum)

Filtro de enumeração — lista plana de valores de enum

valuestring

Exemplo: example

typestringobrigatório

Exemplo: select

optionarray of string

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

auto_paymentobject

Apenas para pagamento automático

idintegerobrigatório

Exemplo: 1

card_idstringobrigatório

Exemplo: 78787878

sumintegerobrigatório

Exemplo: 20

payment_option_idintegerobrigatório

Exemplo: 23

currency_codestringobrigatório

Exemplo: RUB

amountstringobrigatório

Exemplo: 1

Uma das opções

object

Ao converter

conversion_payment_sumnumberobrigatório

Exemplo: 20

conversion_payment_currency_codestringobrigatório

Exemplo: RUB

listarray of object

option_idintegerobrigatório

Exemplo: 23

namestringobrigatório

Exemplo: Visa / MasterCard / MIR

system_methodstringobrigatório

Exemplo: plastic_card

recurrentbooleanobrigatório

Exemplo: true

name_gatewaystringobrigatório

Exemplo: Example Bank

system_namestring

Exemplo: Tinkoff

payment_settings_idinteger

Configuração do gateway de pagamento para a moeda; retornado em payments.add_transaction

Exemplo: 12

currency_codestring

Exemplo: RUB

is_nativeboolean

Exemplo: true

minimum_sum_multiplierinteger

Exemplo: 1

conversion_paymentstring

Exemplo: 1

payment_infoobject

payment_idintegerobrigatório

Exemplo: 1

system_namestringobrigatório

Exemplo: tbank

min_sum_for_paynumber

Exemplo: 600

short_textstring

Exemplo: ₽

test_accountboolean

Exemplo: 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' => 'pt', '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": "pt", "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": "pt", "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 } }