Отримання статусу платежу

URL

https://payparts2.privatbank.ua/ipp/v2/payment/state

Тип запиту

POST

Headers

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

Body запроса

{
  "storeId" : "",
  "orderId" : "ORDER-3196fa3007bc4b6dab8",
  "showRefund": true,
  "signature" : ""
}

Опис полів

поле	формат	опис	обов'язковість
storeId	str	Ідентифікатор магазину	так
orderId	64 символа	Унікальний номер платежу	так
showRefund	bool	true - отримати деталі повернення з платежу, false - отримати статус платежу без додаткових деталей про повернення	ні
showAmount	bool	true – отримати суму угоди, false – не отримувати.	ні
showInfo	bool	true - отримати додаткову інформацію для чека по угоді, false - не отримувати*	ні
signature	str	Унікальний підпис запиту	так

*Додаткові параметри відповіді успішного платежу для виконання норм Наказу Міністерства Фінансів (посилання)

1. cardMask (string), номер картки у форматі 1234 44 ** 5678

2. bankName (string), банк. За замовчуванням PB.

3. authCode (string), код авторизації

4. rrn (string), код РРН

5. paymentSystem (string), платіжна система. На 05.08.21 можливі Visa або MC.

6. ownerName (string) - власник картки-платіжного засобу.

7. terminal (string) - термінал. Наприклад, X1111RJ2.

8. acquirer (string) - Наименування банка-еквайєра

Розрахунок сигнатури для запиту

SIGNATURE - підпис запиту, обов'язковий параметр вважається за формулою encodeBase64 ( SHA1 ( password + storeId + orderId + password )), где:

• encodeBase64 () - Функція зашифровує рядок у форматі BASE64;

• SHA1 () - Стандартна хеш-функція SHA-1 повинна повертати бінарні дані;

• "+" - Конкатенація текстового рядка.

Параметр	Значення
password	Пароль вашого магазину
storeId	Ідентифікатор магазину
orderId	Унікальний номер платежу
password	Пароль вашого магазину

Успішна відповідь

{
  "state" : "",
  "paymentState" : "",
  "storeId" : "merchant",
  "orderId" : "order_id",
  "signature" : "",
   "refunds": [
    {
      "Amount": 3049,
      "CreateDate": "12.09.2020 19:42:16"
    }
  ]
}

Успішна відповідь з параметром showInfo

{
	"orderId": "7026121",
	"paymentState": "SUCCESS",
	"signature": "9QnkMz/ohu5P7Z1IRApSjxYFNfM=",
	"info": {
		"cardMask": "5168 74 ** 1111",
		"bankName": "PrivatBank",
		"authCode": "210810",
		"rrn": "210810154732",
		"paymentSystem": "Mastercard",
		"ownerName": "ТЕСТ АРТЕМ ЮРІЙОВИЧ",
		"terminal": "X1111RJ2",
		"acquirer": "ПРИВАТБАНК"
	},
	"state": "SUCCESS",
	"storeId": "01841655224A4951BBAF"
}

Відповідь з помилкою

{
  "state" : "FAIL",
  "storeId" : "merchant",
  "orderId" : "order_id",
  "message" : "error message",
  "signature" : "37d9c9732fe843929deb01424fb4b0fa"
}

Опис полів

Поле	Опис
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 повинна повертати бінарні дані;

• "+" - Конкатенація текстового рядка.

Параметр	Значення
password	Пароль вашого магазину
state	Результат відпрацювання запиту
storeId	Ідентифікатор магазину
orderId	Унікальний номер платежу
message	У разі помилки містить повідомлення помилки
paymentState	Статус обробки заявки на кредит
password	Пароль вашого магазину