Автоматическая документация для взаимодействия с API:

Swagger

Уведомление о переводе

Уведомление отправляется, если:

  • Был указан URL для уведомлений в личном кабинете;
  • Был получен входящий перевод от пользователя;

Формат запроса

Уведомление отправляется как HTTP-запрос на адрес, указанный в личном кабинете пользователя, в следующем формате:

  • Метод — POST; Каждый параметр уведомления указывается парой ключ/значение в виде параметра POST-запроса;
  • Кодировка символов — UTF‑8.
  • MIME-тип — "application/json".

Параметры уведомления

ПАРАМЕТР ТИП ОПИСАНИЕ
status bool

Идентификатор получения входящего перевода.
order_id string

Внутренний идентификатор счета в системе TerraPay
invoice_id optional[string]

Идентификатор счета для оплаты
amount string

Сумма операции.
currency string

Код валюты выстевленного счета.
buyer_email string

Email покупателя.
user_tag string

Внутренний идентификатор счета в системе клиента.
sha1_hash string

SHA-1 hash параметров уведомления..

Пример получаемого ответа: 

{

                "status": true,

                "order_id": "9ad36faf-7087-4c3c-8acf-aed478df9463",

                "invoice_id": "j4h878hd9h5h",

                "buyer_email": "quickpay@test.test",

                "amount": "100",

                "currency": "RUB",

                "user_tag": "test",

                "sha1_hash": "4457df6dcfbff359f0b8cb2bb7e7dc75c717a334",

              }

Формат ответа

  • Уведомление считается принятым, если получатель ответил на запрос кодом HTTP 200 OK (уведомление отправляется каждые 5 секунд в течение 10 минут).

Расчет хэша

  • Шаг 1.

    Сформировать строку из параметров уведомления в кодировке UTF‑8 (где notification_secret — это секретное слово для проверки уведомлений). Если параметр отсутствует или None, то его необходимо исключить.

  • Формат строки

                      order_id&invoice_id&buyer_email&amount&user_tag&currency&secret_key

    Пример, в котором секретный ключ аккаунта это secret key

                        9ad36faf-7087-4c3c-8acf-aed478df9463&j4h878hd9h5h&quickpay@test.test&100&test&RUB&secret key

  • Шаг 2.

    Вычислить значение хэш-функции SHA-1 от полученной строки.

  • Шаг 3.

    Отформатировать полученный результат в HEX-кодированном виде.

  • Результат

    В результате после 3 шагов получается параметр sha1_hash

                      53ed2efa057066f747efc51252e1f29cf2d156cc
На главную