listCard - Запрос списка зарегистрированных карт
Выполняется с помощью команды listCard.
Этот запрос позволяет получить список карт, хранящихся в theMAP, с целью дальнейшего их использования для оплаты услуг или товаров.
Название |
Описание |
Формат |
Обязательный1 |
key |
Идентификатор Продавца. Выдается Продавцу с параметрами тестового/боевого доступа |
Строка |
|
credential |
|
Объект |
|
├─ login |
Логин держателя карты, зарегистрированного в системе Продавца. Используются для получения списка карт сохраненных за пользователем |
Строка (максимум 50 символов) |
|
├─ password |
Пароль держателя карты, зарегистрированного в системе Продавца. Используются для получения списка карт сохраненных за пользователем |
Строка (максимум 50 символов |
|
├─ merchant_name |
Наименование продавца. Используются для получения списка карт сохраненных за Мерчантом |
Строка (максимум 50 символов |
|
├─ merchant_password |
Пароль Мерчанта для совершения операций. Используются для получения списка карт сохраненных за Мерчантом |
Строка (максимум 50 символов |
|
├─ terminal_password |
Пароль терминала для совершения операций. Используются для получения списка карт сохраненных за терминалом |
Строка (максимум 50 символов |
|
1 Требования обязательности параметров одинаковы для каналов оплаты: eCom
, AP
, GP
Название |
Описание |
Формат |
Обязательный1 |
Key |
Идентификатор Продавца. Выдается Продавцу с параметрами тестового/боевого доступа |
Строка |
|
TerminalPassword |
Пароль терминала для совершения операций. Используются для получения списка карт сохраненных за терминалом |
Строка (максимум 50 символов |
|
Login |
Логин держателя карты, зарегистрированного в системе Продавца. Используются для получения списка карт сохраненных за пользователем |
Строка (максимум 50 символов) |
|
Password |
Пароль держателя карты, зарегистрированного в системе Продавца. Используются для получения списка карт сохраненных за пользователем |
Строка (максимум 50 символов |
|
Merchant |
Наименование продавца. Используются для получения списка карт сохраненных за Мерчантом |
Строка (максимум 50 символов |
|
MerchantPassword |
Пароль Мерчанта для совершения операций. Используются для получения списка карт сохраненных за Мерчантом |
Строка (максимум 50 символов |
|
1 Требования обязательности параметров одинаковы для каналов оплаты: eCom
, AP
, GP
Пример запроса POST:
Content-Type: application/json
https:{domain}/listCard
{
"key": "TestTerminal",
"credential": {
"login": "TestUser",
"password": "123"
}
}
Пример реализации запроса в программном коде:
curl -X POST \
https:https:{domain}/listCard \
-H 'Content-Type: application/json' \
-d '{"key":"TestTerminal","credential":{"login":"TestUser","password":"123"}}'
Пример запроса POST:
Content-Type: application/x-www-form-urlencoded
https:{domain}/listCard
Key : TestTerminal
Login : TestUser
Password : 123
Пример реализации запроса в программном коде:
curl -X POST \
https:https:{domain}/listCard \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'Key=TestTerminal&Login=TestUser&Password=123'
Название |
Описание |
Формат |
Обязательный1 |
Success |
Флаг успешности операции |
true/false |
|
CardUId |
Идентификатор удаляемой карты в системе theMAP |
GUID |
2 |
PanMask |
Маскированный номер карты в формате 123456xxxxxx1234 |
Строка |
|
CardHolder |
Фамилия, имя держателя карты, указанные на лицевой стороне карты |
Строка, 50 символов |
|
Status |
Статус карты. Active – карта активна и может быть использована для списаний |
Строка, 50 символов |
2 |
ErrCode |
Код ошибки |
см. коды ошибок |
3 |
1 Обязательные параметры одинаковы для всех eCom
, AP
, GP
2 Передаётся, если в ответе Success=true
3 Передаётся, если в ответе Success=false
Пример ответа на успешный запрос:
{
"PanMask": "411111xxxxxx1111",
"CardUId": "Gnxs8dXqhObnvKwy38djkG",
"EMonth": 12,
"EYear": 21,
"Status": "Active",
"CardHolder": "Ivan Ivanov"
}
{
"PanMask": "411111xxxxxx0023",
"CardUId": "flsWu82F7j8UUMmbcPws89Nx3",
"EMonth": 12,
"EYear": 22,
"Status": "Active",
"CardHolder": "Ivan Ivanov"
}
Пример ответа на не успешный запрос:
{
"Success": false,
"ErrCode": "INVALID_AUTHENTICATION"
}