Yandex Pay

Введение

Платежный шлюз поддерживает прием платежей через Yandex Pay. У клиента есть возможность оплатить покупку, нажав на соответствующую кнопку.

Если используется платежная страница на стороне Платежного шлюза, дополнительных действий по подключению этого способа оплаты не требуется.

Если вы используете свою платежную страницу, необходимы следующие предварительные действия:

1. Получите идентификатор продавца YandexPay Id (https://pay.yandex.ru/business).
2. Установите полученный идентификатор в личном кабинете. Для этого перейдите в раздел Сертификаты > Yandex Pay > Создать пару ключей > введите логин продавца и полученный идентификатор.
3. Зарегистрируйте полученную пару ключей в Yandex (обратитесь в команду поддержки).

Схема интеграции

1. Клиент формирует заказ на сайте Мерчанта и выбирает оплату Yandex Pay.
2. Платежная форма на стороне Мерчанта формирует запрос к Yandex на формирование платежного токена.
3. Yandex отображает информацию о покупке, позволяя Клиенту выбрать средство оплаты Yandex Pay.
4. Клиент вводит необходимые данные и подтверждает оплату.
5. Yandex формирует зашифрованные платежные данные.
6. Yandex возвращает зашифрованные данные на платежную страницу на стороне Мерчанта.
7. Мерчант отправляет в Платежный шлюз запрос на оплату YandexPay /yandex/instantPayment.do, передавая зашифрованные данные в параметре paymentToken.
8. Платежный шлюз регистрирует заказ.
9. Платежный шлюз расшифровывает значение, полученное в параметре paymentToken.
10. Платежный шлюз осуществляет оплату и фискализацию (если она предусмотрена).
11. В случае двухстадийного платежа Платежный шлюз отправляет нотификацию о блокировке средств в момент блокировки. После проведения оплаты Платежный шлюз отправляет нотификацию об оплате Yandex Pay.
12. Yandex Pay подтверждает получение результата оплаты.
13. Платежный шлюз возвращает результат оплаты Мерчанту. При этом, если требуется 3DS2 аутентификация, в ответе, в том числе, возвращаются параметры, относящиеся к 3DSv2 (threeDSServerTransId, threeDSMethodURLServer, threeDSMethodURL, threeDSMethodDataPacked).

14. Если 3DS2 аутентификация не требуется, выполняется переход на шаг 23.

    Если требуется (ответ содержит threeDSMethodURLServer)  – Мерчант в отдельном "iframe" методом POST вызывает threeDSMethodURLServer.

15. Если в ответе присутствуют параметры threeDSMethodURL и threeDSMethodDataPacked, Мерчант в отдельном "iframe" методом POST вызывает threeDSMethodURL (адрес ACS).

16. (Продолжение оплаты) Мерчант отправляет повторный запрос /yandex/instantPayment.do. При этом необходимо передать параметр threeDSServerTransId – идентификатор транзакции, который был создан сервером 3DS и возвращён на шаге 13. Кроме того, для переадресации клиента на страницу магазина после проведения оплаты заказа можно передать ссылку переадресации в параметре threeDSVer2FinishUrl.

17. Платежный шлюз взаимодействует с сервером 3DS и ACS, чтобы выяснить, требуется ли клиенту проходить аутентификацию на ACS, и отправляет ответ на запрос оплаты. Если клиенту требуется проходить аутентификацию на ACS, в ответе возвращается acsUrl – URL для перенаправления на ACS, а также packedCReq – упакованные данные для challenge request. Если не требуется (frictionless аутентификация) – возвращается ответ об успешном завершении оплаты.

18. Если аутентификация на ACS не требуется, выполняется переход на шаг 23.

    Если требуется – продавец перенаправляет клиента на ACS. Читайте, как это сделать, здесь.

19. Клиент проходит проверку подлинности.

20. ACS перенаправляет клиента на страницу магазина.

21. Если в запросе на оплату был передан параметр threeDSVer2FinishUrl, для завершения транзакции Мерчант отправляет в платежный шлюз запрос finish3dsVer2Payment.do. В этом запросе нужно передать параметр threeDSServerTransId - идентификатор транзакции, который был создан сервером 3DS и возвращён на шаге 13.

22. Платежный шлюз возвращает результат оплаты Мерчанту.

23. Платежная страница на стороне Мерчанта отображает результат оплаты Клиенту.

API-запрос регистрации и оплаты Yandex Pay

Мгновенная оплата Yandex Pay

Запрос, используемый для регистрации заказа и одновременной оплаты за него – /yandex/instantPayment.do.

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

Ниже приведены параметры блока billingPayerData (данные об адресе регистрации клиента).

Описание параметров в объекте orderBundle:

Описание параметров в объекте customerDetails:

Описание параметров в объекте deliveryInfo:

Описание параметров в объекте cartItems:

Описание параметров в объекте items:

Описание параметров в объекте quantity:

Возможные значения параметра measure.

Описание параметров в объекте itemDetails:

Описание параметров в объекте itemDetailsParams:

Описание параметров в объекте discount:

Описание параметров в объекте agentInterest:

Описание параметров объекта tax.

Описание параметров в объекте itemAttributes:

Параметр itemAttributes должен содержать массив attributes, а уже в этом массиве расположены атрибуты товарной позиции (см. пример и таблицу ниже).

"itemAttributes":{"attributes":[{"name":"paymentMethod","value":"1"},{"name":"paymentObject","value":"1"}]}

* Обязателен, если передается agent_info.

Описание параметров объекта markQuantity.

Описание параметров в объекте additionalOfdParams:

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

Блок data содержит следующие элементы.

Блок error содержит следующие элементы.

Примеры

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

curl --location 'https://vtb.rbsuat.com/payment/yandex/instantPayment.do' \
--header 'Content-Type: application/json' \
--data '{
"merchant": "OurBestMerchantLogin",
"amount":1000000,
"orderNumber":"1255555555555",
"currencyCode" : 643,
"failUrl" : "https://mybestmerchantfailurl.com",
"returnUrl" : "https://mybestmerchantreturnurl.com",
"description" : "Test description",
"paymentToken": "eyJzaWdu...yVDA0WjY2ST1cIn0ifQ==",
"sessionTimeoutSecs":"1000000",
"ip" : "127.0.0.1",
"jsonParams":
    {"notGenerateOfdReceipt":"true"},
"orderBundle":
    {"cartItems":
        {
        "items":
            [
            {"positionId":"1","name":"TEST","quantity":{"value":1.0,"measure":"psc"},"itemAmount":500000,"itemCode":"code1","itemPrice":"500000","tax":{"taxType":2},"itemAttributes":{"attributes":[{"name":"paymentMethod","value":"2"},{"name":"paymentObject","value":"2"}]}},
            {"positionId":"2","name":"TEST2","quantity":{"value":1.0,"measure":"psc"},"itemAmount":500000,"itemCode":"code2","itemPrice":"500000","tax":{"taxType":2},"itemAttributes":{"attributes":[{"name":"paymentMethod","value":"2"},{"name":"paymentObject","value":"2"}]}}
            ]
            }
        }
    }   
}'

Пример повторного запроса (для 3DS2)

curl --location 'https://vtb.rbsuat.com/payment/yandex/instantPayment.do' \
--header 'Content-Type: application/json' \
--data '{
    "username": "test-user",
    "password": "test-password",
    "paymentToken": "eyJzaWdu...yVDA0WjY2ST1cIn0ifQ==",
    "amount": 1000000,
    "returnUrl": "https://mybestmerchantreturnurl.com",
    "threeDSVer2FinishUrl": "http://finish.com",
    "threeDSVer2MdOrder": "20118da6-be2d-75ba-be89-273b085e076d",
    "threeDSServerTransId": "e06d137a-b68a-41d5-8998-af3e13ab8195"
}'

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

{
    "success": true,
    "data": {
        "orderNumber": "4e77a01b-5a75-7f92-9560-434e01228ae9",
        "redirectUrl": "https://do13.do.rbstest.ru/payment/merchants/rbs/finish.html?orderId=4e77a01b-5a75-7f92-9560-434e01228ae9&lang=ru",
        "transactionId": "ddc687bf-c82c-48ec-be81-0b8fea42cd28"
    }
}

Пример ответа на первый запрос для 3DS2

{
    "success": true,
    "data": {
        "orderNumber": "12312312123",
        "is3DSVer2": true,
        "threeDSServerTransId": "5802746e-3393-40c3-929a-dc966ebf08c6",
        "threeDSMethodURL": "https://example.com/acs2/acs/3dsMethod",
        "threeDSMethodURLServer": "example.com/3dsserver/api/v1/client/gather?threeDSServerTransID=5802746e-3393-40c3-929a-dc966ebf08c6",
        "threeDSMethodDataPacked": "eyJ0aHJlZURTTWV0aG9kTm90aWZpY2F0aW9uVVJMIjoiaHR0cHM6Ly9jb21tb24wMy50c3QucmJzdGVzdC5ydS8zZHNzZXJ2ZXIvYXBpL3YxL2Fjcy9ub3RpZmljYXRpb24_dGhyZWVEU1NlcnZlclRyYW5zSUQ9NTgwMjc0NmUtMzM5My00MGMzLTkyOWEtZGM5NjZlYmYwOGM2IiwidGhyZWVEU1NlcnZlclRyYW5zSUQiOiI1ODAyNzQ2ZS0zMzkzLTQwYzMtOTI5YS1kYzk2NmViZjA4YzYifQ"
    }
}

Пример ответа на повторный запрос для 3DS2

{
    "success": true,
    "data": {
        "orderNumber": "44f379fd-4f70-782a-b742-36b501228ae9",
        "acsUrl": "https://web.rbsuat.com/acs/auth/start.do",
        "paReq": "eJxVkVtTwjAQhf8K0/eSS0tbmCUOiox9aBXEcXwM6SpF2kJoFfvrTbgIvu232TlncxZu9sW684V
6l1fl0GFd6nSwVFWWlx9D52U+cSPnRsB8qRHHz6gajQIS3O3kB3bybOjQMIveFx51Q8o91+8H0o0iFbm+CjHsq57C0HcE
PI1muBVwMhLGp8uBnNEoarWUZS1Aqu1tnAqfhwGlQE4IBep4LBj3/F4QRkCODKUsUDwvC/lZfQE5EKiqKWv9IwLfA3IGa
PRaLOt6MyDkR3Z1A8R2gFycnxpb7YzCPs9EskradDzap6t7nqxinrQJe5zH32n7NgRiJyCTNQpOOaMB5R3GBp43YOZXhz
7IwloLRg/fOAJsrMfo+uW6AyZebdI/734mwP2mKtFMGPW/Gshl47sHm5yqTSZtO5mUK674/Uv6UM+m62j6uk18XPjb2OZ
5GLKKuYml32dHSQtArAw5nYqcrmyqf9f/BX9Qtv8=",
        "termUrl": "https://do13.do.rbstest.ru/payment/rest/finish3ds.do"
    }
}