Получение статуса платежа

URL

Тип запроса

POST

Заголовки

Название
Значение
Accept:
application/json;
Accept-Encoding:
UTF-8;
Content-Type:
application/json; charset=UTF-8;

Тело запроса

1
{
2
"storeId" : "",
3
"orderId" : "ORDER-3196fa3007bc4b6dab8",
4
"showRefund": true,
5
"signature" : ""
6
}
Copied!

Описание полей

Поле
Формат
Описание
Обязательное
storeId
str
Идентификатор магазина
Да
orderId
64 символа
Уникальный номер платежа
Да
showRefund
bool
true - получить детали возвратов по платежу, false - получить статус платежа без дополнительных деталей о возвратах
Нет
showAmount
bool
true - получить сумму сделки, false - не получать.
Нет
showInfo
bool
true - получить доп инфо для чека по сделке, false - не получать*
Нет
signature
str
Уникальная подпись транзакции
Да
*Додаткові параметри відповіді успішного платежу для виконання норм Наказу Міністерства Фінансів (посилання)
  1. 1.
    cardMask (string), номер картки у форматі 1234 44 ** 5678
  2. 2.
    bankName (string), банк. За замовчуванням PB.
  3. 3.
    authCode (string), код авторизації
  4. 4.
    rrn (string), код РРН
  5. 5.
    paymentSystem (string), платіжна система. На 05.08.21 можливі Visa або MC.
  6. 6.
    ownerName (string) - власник картки-платіжного засобу.
  7. 7.
    terminal (string) - термінал. Наприклад, X1111RJ2.
  8. 8.
    acquirer (string) - Наименование банка-эквайера

Расчет сигнатуры для запроса

SIGNATURE - подпись запроса, обязательный параметр считается по формуле :encodeBase64 ( SHA1 ( password + storeId + orderId + password )), где:
  • encodeBase64 () - Функция зашифровывает строку в формате BASE64;
  • SHA1 () - Стандартная хеш-функция SHA-1, должна возвращать бинарные данные;
  • "+" - Конкатенация текстовой строки.
Параметр
Значение
password
Пароль вашего магазина
storeId
Идентификатор магазина
orderId
Уникальный номер платежа
password
Пароль вашего магазина

Успешный ответ

1
{
2
"state" : "",
3
"paymentState" : "",
4
"storeId" : "merchant",
5
"orderId" : "order_id",
6
"signature" : "",
7
"refunds": [
8
{
9
"Amount": 3049,
10
"CreateDate": "12.09.2020 19:42:16"
11
}
12
]
13
}
Copied!

Успешный ответ c параметром showInfo

1
{
2
"orderId": "7026121",
3
"paymentState": "SUCCESS",
4
"signature": "9QnkMz/ohu5P7Z1IRApSjxYFNfM=",
5
"info": {
6
"cardMask": "5168 74 ** 1111",
7
"bankName": "PrivatBank",
8
"authCode": "210810",
9
"rrn": "210810154732",
10
"paymentSystem": "Mastercard",
11
"ownerName": "ТЕСТ АРТЕМ ЮРІЙОВИЧ",
12
"terminal": "X1111RJ2",
13
"acquirer": "ПРИВАТБАНК"
14
},
15
"state": "SUCCESS",
16
"storeId": "01841655224A4951BBAF"
17
}
Copied!

Ответ с ошибкой

1
{
2
"state" : "FAIL",
3
"storeId" : "merchant",
4
"orderId" : "order_id",
5
"message" : "error message",
6
"signature" : "37d9c9732fe843929deb01424fb4b0fa"
7
}
Copied!

Описание полей

Поле
Описание
state
Статус отработки запроса
paymentState
Статус обработки заявки на кредит
storeId
Идентификатор магазина
orderId
Уникальный номер платежа
message
Сообщение об ошибке
description
Описание платежа (Если пустое, то не возвращается)
amount
Сумма сделки
signature
Подпись запроса
refunds
массив с инфо по возврату
Amount
сумма возврата
CreateDate
дата возврата

Расчет сигнатуры для ответа

SIGNATURE = encodeBase64 ( SHA1 ( password + state + storeId + orderId + paymentState + message + password ))
  • encodeBase64 () - Функция зашифровывает строку в формате BASE64;
  • SHA1 () - Стандартная хеш-функция SHA-1, должна возвращать бинарные данные;
  • withoutFloatingPoint () - Функция возвращает число без плавающей точки ;
  • + - Конкатенация текстовой строки.
Параметр
Значение
password
Пароль вашего магазина
state
Результат отработки запроса
storeId
Идентификатор магазина
orderId
Уникальный номер платежа
message
В случае ошибки, содержит сообщение ошибки
paymentState
Статус обработки заявки на кредит
password
Пароль вашего магазина