GetList

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

The GetList command retrieves the list of the Customer's payment cards registered in the Payture system. GetList does not return removed cards or expired cards.

The maximum number of cards in a GetList response is 20. Cards are sorted by the date of the last successful charge or hold of funds.

Request

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" \

Get link

Parameter names in requests are case-sensitive

Parameter	Description	Format
VWID	Payment terminal name Provided with the test/production access credentials	String Mandatory
DATA	Customer parameters A URL-encoded string containing key-value pairs separated by “;” (semicolon). Keys and values are separated by “=” (equals sign)	String Mandatory

DATA parameter keys

Parameter	Description	Format
VWUserLgn	Customer identifier in the Payture system	String [1..50] Mandatory
VWUserPsw	Additional access parameter for the Customer's private information (Customer password)	String [1..50] Mandatory

Example of the DATA parameter (decoded):

VWUserLgn=123@ya.ru;
VWUserPsw=2645363

Response

An XML string with the GetList element and nested Item elements

Response examples

<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>

Parameter	Description	Format
Success	Operation success flag. Possible values: `True` — the operation succeeded `False` — the operation failed	String Mandatory
VWUserLgn	Customer identifier in the Payture system Matches the value passed in the request	String [1..50] Mandatory
Item	List of the Customer's cards Returned if “Success=True”	Object Optional
ErrCode	Error code. See error codes Returned if “Success=False”	String Optional

Item element attributes

Parameter	Description	Format
CardName	Masked card number (first 6 and last 4 digits: 123456xxxxxx1234) Returned if “Success=True” or “Success=3DS”	String [13..19] Mandatory
CardId	Card identifier in the Payture system Returned if “Success=True” or “Success=3DS”	String [36] Mandatory
CardHolder	Cardholder's last and first name Latin letters and spaces only	String [1..30] Mandatory
Status	Current card status: `IsActive` — the card is activated (a payment or card removal request can be sent) `NotActive` — the card is not activated (a card activation or card removal request can be sent) `NotActive3DS` — the card is enrolled in 3-D Secure and not activated (a card activation or card removal request can be sent)	String Mandatory
NoCVV	Whether the card can be charged without entering CVV2/CVC2: `true` — payment is possible `false` — payment is not possible	Boolean Mandatory
Expired	Card expiration flag: `true` — the card has expired `false` — the card has not expired	Boolean Mandatory
ExpMonth	Card expiration month 2 digits. Returned by arrangement with Payture support	Integer Optional
ExpYear	Card expiration year 4 digits. Returned by arrangement with Payture support	Integer Optional
PaymentSystem	Card scheme Returned by arrangement with Payture support	String [20] Optional
Param	Additional card parameters Each parameter is returned in a nested Param element in the `Key={Key} Value={Value}` format	Object Optional

Possible Param element attributes

Parameter	Description	Format
BindingOrderId	Payment ID (order number) with which the card was added Returned if the card was added together with a payment	String [1..50] Optional
LastSuccess	Date and time of the last successful charge in a one-step payment or hold of funds in a two-step payment Returned if the card has had a successful payment	String Optional
LastSuccessOrderId	Order number of the last successful charge in a one-step payment or hold of funds in a two-step payment Returned by arrangement with Payture support	String Optional
LastLessSecureCode:VWID	Terminal name and the success flag of the last payment without CVV2/CVC2 (recurring payment): `True` — the last recurring payment succeeded `False` — the last recurring payment failed Returned if the card has had a recurring payment	String Optional
ExternalWallet	Card type flag: `ApplePay` — Apple Pay `GooglePayToken` — tokenized Google Pay card (CRYPTOGRAM_3DS) `GooglePayCard` — non-tokenized Google Pay card (PAN_ONLY) `SamsungPay` — Samsung Pay `SBP` — Russia's Faster Payments System (SBP) Returned for cards from Apple Pay, Google Pay, or Samsung Pay wallets	String Optional
CAVV	Cardholder authentication verification value Returned for cards from Apple Pay, Google Pay, or Samsung Pay wallets	String Optional