GetList

https://{Environment}.payture.com/vwapi/GetList

Команда GetList позволяет получить список платежных карт Покупателя, зарегистрированных в системе Payture. GetList не возвращает удаленные карты и карты с истекшим сроком действия.

Максимальное количество карт в ответе GetList: 20. Карты сортируются по дате последней успешной операции списания или блокирования денежных средств.

Запрос

curl https://sandbox3.payture.com/vwapi/GetList \
-X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d VWID=Merchant \
--data-urlencode "DATA= \
VWUserLgn=123@ya.ru; \
VWUserPsw=2645363" \

Получить ссылку

В запросах наименования параметров чувствительны к регистру

Параметр	Описание	Формат
VWID	Наименование платежного Терминала Предоставляется с параметрами тестового/рабочего доступа	String Mandatory
DATA	Параметры Покупателя Url Encoded строка, содержащая пары ключей и их значений, разделённые символом «;» (точка с запятой). Ключи и значения разделены символом «=» (равно)	String Mandatory

Состав ключей параметра DATA

Параметр	Описание	Формат
VWUserLgn	Идентификатор Покупателя в системе Payture	String [1..50] Mandatory
VWUserPsw	Дополнительный параметр доступа к приватной информации Покупателя (пароль Покупателя)	String [1..50] Mandatory

Пример параметра DATA (decoded):

VWUserLgn=123@ya.ru;
VWUserPsw=2645363

Ответ

XML строка с элементом GetList и вложенными элементами Item

Примеры ответов

<GetList Success="True" VWUserLgn="123@ya.ru">
  <Item CardName="411111xxxxxx1112" CardId="e5dfa016-27e0-45bb-8167-44299642b529" CardHolder="Ivan Ivanov" Status="NotActive" NoCVV="false" Expired="false" ExpMonth="12" ExpYear="2022" PaymentSystem="Visa"/>
    <Param Key="ExternalWallet" Value="ApplePay" />
    <Param Key="CAVV" Value="/oasQvoGZxvwxyU5V/RYMAACAAA=" />
    <Param Key="BindingOrderId" Value="d5f8531f-308b-4470-96c9-e56be812896b" />
    <Param Key="LastSuccess" Value="2019.08.17 18:22:07" />
    <Param Key="LastSuccessOrderId" Value="4b7638ef-c1bf-4e8b-8530-9bc13825c1d8" />
  </Item>
  <Item CardName="411111xxxxxx1111" CardId="001f2def-64e9-4cef-ae02-aa2bd9508a8b" CardHolder="Ivan Ivanov" Status="IsActive" NoCVV="true" Expired="false" ExpMonth="12" ExpYear="2022" PaymentSystem="Visa">
    <Param Key="LastSuccess" Value="2019.06.24 12:42:14"/>
    <Param Key="LastSuccessOrderId" Value="4b7638ef-c1bf-4e8b-8530-9bc13825c1d8" />
    <Param Key="LastLessSecureCode:VWMerchantTest" Value="True"/>
    <Param Key="BindingOrderId" Value="a760d6a6-4c6f-4687-95c2-e1c7dcc8151f"/>
  </Item>
</GetList>

Параметр	Описание	Формат
Success	Признак успешности операции. Принимает значения: `True` — операция успешна `False` — операция неуспешна	String Mandatory
VWUserLgn	Идентификатор Покупателя в системе Payture Соответствует переданному в запросе	String [1..50] Mandatory
Item	Список карт Покупателя Передается, если «Success=True»	Object Optional
ErrCode	Код ошибки. См. коды ошибок Передается, если «Success=False»	String Optional

Атрибуты элемента Item

Параметр	Описание	Формат
CardName	Маскированный номер карты (первые 6 и последние 4 цифры: 123456хххххх1234) Передается, если «Success=True» или «Success=3DS»	String [13..19] Mandatory
CardId	Идентификатор карты в системе Payture Передается, если «Success=True» или «Success=3DS»	String [36] Mandatory
CardHolder	Фамилия и имя держателя карты Только латинские буквы и пробел	String [1..30] Mandatory
Status	Текущий статус карты: `IsActive` — карта активирована (возможно выполнение запроса проведения платежа, удаления карты) `NotActive` — карта не активирована (возможно выполнение запроса активации карты, удаления карты) `NotActive3DS` — карта вовлечена в 3-D Secure и не активирована (возможно выполнение запроса активации карты, удаления карты)	String Mandatory
NoCVV	Возможность оплаты по карте без введения CVV2/CVC2: `true` — оплата возможна `false` — оплата невозможна	Boolean Mandatory
Expired	Признак истечения срока действия карты: `true` — срок действия карты истек `false` — срок действия не истек	Boolean Mandatory
ExpMonth	Месяц истечения срока действия карты 2 цифры. Передается по согласованию со службой поддержки Payture	Integer Optional
ExpYear	Год истечения срока действия карты 4 цифры. Передается по согласованию со службой поддержки Payture	Integer Optional
PaymentSystem	Платежная система Передается по согласованию со службой поддержки Payture	String [20] Optional
Param	Дополнительные параметры карты Каждый параметр передается во вложенном элементе Param в формате `Key={Key} Value={Value}`	Object Optional

Возможные атрибуты элемента Param

Параметр	Описание	Формат
BindingOrderId	Идентификатор платежа (номер заказа), при котором была добавлена карта Передается, если карта была добавлена с платежом	String [1..50] Optional
LastSuccess	Дата и время последнего успешного списания в рамках одностодийного платежа или блокирования средств в рамках двухстадийного платежа Передается, если по карте был успешный платеж	String Optional
LastSuccessOrderId	Номер заказа последнего успешного списания в рамках одностодийного платежа или блокирования средств в рамках двухстадийного платежа Передается по согласованию со службой поддержки Payture	String Optional
LastLessSecureCode:VWID	Наименование терминала и признак успешности последнего платежа без CVV2/CVC2 (рекуррентный платеж): `True` — последний рекуррентный платеж успешен `False` — последний рекуррентный платеж неуспешен Передается, если по карте был рекуррентный платеж	String Optional
ExternalWallet	Признак карты: `ApplePay` — Apple Pay `GooglePayToken` — токенизированная карта Google Pay (CRYPTOGRAM_3DS) `GooglePayCard` — нетокенизированная карта Google Pay (PAN_ONLY) `SamsungPay` — Samsung Pay `СБП` — Система быстрых платежей Передается для карт из кошельков Apple Pay, Google Pay или Samsung Pay	String Optional
CAVV	Код проверки подлинности держателя карты Передается для карт из кошельков Apple Pay, Google Pay или Samsung Pay	String Optional