Запрос списка всех связок клиента (getBindings.do)

Для получения списка связок по идентификатору клиента используется запрос getBindings.do.

В настоящем документе при описании параметров запросов и ответов используются следующие обозначения типов данных:

A<n> – последовательность латинских букв длины <n>;
A..<n> – последовательность латинских букв длиной, не превышающей <n>;
N<n> – последовательность цифр длины <n>;
N..<n> – последовательность цифр длиной, не превышающей <n>;
AN<n> – последовательность латинских букв и цифр фиксированной длины <n>;
AN..<n> – последовательность латинских букв и цифр длиной, не превышающей <n>;
ANS<n> – последовательность латинских букв, цифр и символов фиксированной длины <n>
ANS..<n> – последовательность латинских букв, цифр и символов длиной, не превышающей <n>;
UTC – дата и время, при этом: дата должна быть передана без указания часового пояса, время московское, для протокола SOAP используется стандартная кодировка xs:dateTime.

Пользуясь протоколом REST, тело сообщения запроса следует отправлять с типом: 'Content-Type: application/x-www-form-urlencoded'.

Параметры запроса

Название	Тип	Обязательно	Описание
`userName`	AN..30	Да	Логин служебной учётной записи продавца.
`password`	AN..200	Да	Пароль служебной учётной записи продавца.
`clientId`	ANS..255	Да	Номер (идентификатор) клиента в системе магазина. Используется для реализации функционала связок. Может присутствовать, если магазину разрешено создание связок. Указание этого параметра при платежах по связке необходимо - в противном случае платёж будет неуспешен.
`bindingId`	AN..255	Нет	Идентификатор связки, созданной ранее.
`showExpired`	булеан	Нет	Параметр определяет необходимость отображать связки с истёкшим сроком действия карты. Возможные значения: `true`, `false`. По умолчанию параметр принимает значение `false`.
`bindingType`	ENUM (A1 на элемент)	Да	Перечень возможных значений: С - обычная связка для платежей вне определенного платежного графика или расписания; I - связка для платежей в рассрочку; R - связка для рекуррентных платежей; CR - связка используется для хранения PAN получателя в P2P операциях.
`language`	A2	Нет	Язык в кодировке ISO 639-1. Если не указан, будет использован язык, указанный в настройках магазина как язык по умолчанию.
`merchantLogin`	ANS..255	Нет	Чтобы зарегистрировать заказ от имени дочернего продавца, укажите его логин в этом параметре.

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

Название	Тип	Обязательно	Описание
`errorCode`	N..2	Да	Код ошибки. Может отсутствовать, если результат не привёл к ошибке.
`errorMessage`	AN..512	При ошибке	Описание ошибки на языке, переданном в параметре `language` в запросе.
Элемент `bindings`
`bindingId`	AN..255	Нет	Идентификатор созданной ранее связки. Может использоваться, только если у продавца есть разрешение на работу со связками. Если этот параметр передаётся в данном запросе, то это означает: 1. Данный заказ может быть оплачен только с помощью связки; 2. Плательщик будет перенаправлен на платёжную страницу, где требуется только ввод CVC.
`maskedPan`	N..19	Нет	Маскированный номер карты, которая использовалась для оплаты.
`expiryDate`	N6	Нет	Срок истечения действия карты в формате ГГГГММ. Указан только после оплаты заказа.
`clientId`	ANS..255	Нет	Номер (идентификатор) клиента в системе магазина.
`paymentWay`	AS..14	Нет	Способ совершения платежа (платёж в с вводом карточных данных, оплата по связке и т. п.). Может принимать следующие значения: `CARD` - оплата с вводом карточных данных; `CARD_BINDING` - оплата связкой; `CARD_MOTO` - оплата через колл-центр; `CARD_PRESENT` - оплата как cardPresent; `SBRF_SBOL` - оплата через Сбербанк Онлайн; `UPOP` - оплата через China Union Pay; `FILE_BINDING` - оплата через файл; `FILE_SBP_C2B_BINDING` - СБП оплата через файл; `SMS_BINDING` - оплата через смс; `P2P` - перевод с карты на карту; `P2P_BINDING` - перевод связкой; `PAYPAL` - оплата со счёта PayPal; `MTS` - оплата со счёта МТС; `APPLE_PAY` - Apple Pay; `APPLE_PAY_BINDING` - оплата связкой Apple Pay; `APPLE_PAY_RAW` - оплата Apple Pay с данными по связке на стороне мерчанта (инициирующие и последующие платежи); `ANDROID_PAY` - Android Pay; `ANDROID_PAY_BINDING` - оплата связкой Android Pay; `GOOGLE_PAY_CARD` - Google Pay нетокенизированная; `GOOGLE_PAY_RAW` - оплата Google Pay с данными по связке на стороне мерчанта (инициирующие и последующие платежи); `GOOGLE_PAY_CARD_BINDING` - оплата связкой с не токенизированной картой GooglePay; `GOOGLE_PAY_TOKENIZED` - Google Pay токенизированная; `GOOGLE_PAY_TOKENIZED_BINDING` - оплата связкой с токенизированной картой GooglePay; `SAMSUNG_PAY` - Samsung Pay; `SAMSUNG_PAY_BINDING` - оплата связкой Samsung Pay; `SAMSUNG_PAY_RAW` - оплата Samsung Pay с данными по связке на стороне мерчанта (инициирующие и последующие платежи); `IPOS` - оплата iPOS; `SBERID` - оплата SberID; `SENDY` - оплата Sendy; `SBP_C2B` - Оплата СБП (Сервис Быстрых платежей) для C2B; `SBP_C2B_BINDING` - оплата связкой СБП (Сервис Быстрых Платежей) для C2B; `SBP_B2C` - выплаты СБП; `TOKEN_PAY` - оплата токеном напрямую; `TOKEN_PAY_BINDING` - оплата токенизированной связкой; `YANDEX_PAY_CARD` - YandexPay нетокенизированная; `YANDEX_PAY_TOKENIZED` - YandexPay токенизированная; `YANDEX_PAY_CARD_BINDING` - оплата связкой с не токенизированной картой YandexPay; `YANDEX_PAY_TOKENIZED_BINDING` - оплата связкой с токенизированной картой YandexPay; `MONEY_STREAM` - оплата с баланса мобильного телефона через сервис MoneyStream; `BNPL` - оплата заказа через механизм BNPL (Buy Now Pay Later); `MTS_INSTALLMENT` - оплата в рассрочку через МТС Банк; `MTS_PAY` - MTS Pay; `QR` - оплата по QR-коду; `ALFAPAY_PLATIQR` - оплата Alfa Pay по QR-коду; `TINKOFFPAY_PLATIQR` - оплата Tinkoff Pay по QR-коду.
`paymentSystem`	N..10	Нет	Наименование платёжной системы. Доступны следующие варианты: `VISA`; `MASTERCARD`; `AMEX`; `JCB`; `CUP`; `MIR`. Если заказ был оплачен Платежным счетом или сервисом «Плати частями», то данный параметр не возвращается.
`bindingCategory`	ENUM (A1 на элемент)	Нет	Перечень возможных значений: С - обычная связка для платежей вне определенного платежного графика или расписания; I - связка для платежей в рассрочку; R - связка для рекуррентных платежей; CR - связка используется для хранения PAN получателя в P2P операциях.
`displayLabel`	NS..16	Нет	Последние 4 цифры оригинального пана до токенизации.

Коды ошибок

Код ошибки	Текст ошибки
0	Обработка запроса прошла без системных ошибок.
1	`[clientId]` не задан.
2	Информация не найдена.
5	Доступ запрещён.
5	Пользователь должен сменить свой пароль.
7	Системная ошибка.

Примеры

Пример запроса POST

clientId=12345678&userName=username&password=password&showExpired=false&language=ru&bindingType=C

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

{"errorCode":"0","errorMessage":"Успешно","bindings":[{"bindingId":"614d6438-40fe-7b65-9d22-b41d00cd1fba","maskedPan":"555555XXXXXX5599","expiryDate":"202412","paymentWay":"CARD"},{"bindingId":"22397ac5-af0b-7daa-b1e6-48a300cd1fba","maskedPan":"427601XXXXXX6064","expiryDate":"202412","paymentWay":"CARD"},{"bindingId":"2912702b-4c5b-7822-9cd7-260500cd1fba","maskedPan":"427601XXXXXX6122","expiryDate":"202212","paymentWay":"CARD"},{"bindingId":"fa0c41fb-fb94-709c-83f9-0aca00cd1fba","maskedPan":"427601XXXXXX6065","expiryDate":"202412","paymentWay":"CARD"}]}