QR Master Pass: відмінності між версіями

Матеріал з partnerdocs
 
(Не показано 11 проміжних версій цього користувача)
Рядок 2: Рядок 2:


== Отримання даних для QR-code ==
== Отримання даних для QR-code ==
----Потрібно створити сесію (для детальної інформації перейдіть за посиланням - [[MerchantAPI#Створення сесії|Створення сесії]]). Після цього необхідно створити замовлення ([[MerchantAPI#Створення замовлення|Створення замовлення]]).
Потрібно створити сесію (для детальної інформації перейдіть за посиланням - [[MerchantAPI#Створення сесії|Створення сесії]]). Після цього необхідно створити замовлення ([[MerchantAPI#Створення замовлення|Створення замовлення]]).


У відповіді в '''<code>paymentInstrumentsTypes => instrumentType: "QrMasterpass"</code>''' об'єкт, який містить інформацію для формування QR code. У '''<code>instrumentvalue</code>''' буде рядок, з якого потрібно генерувати QR code.
У відповіді в '''<code>paymentInstrumentsTypes => instrumentType: "QrMasterpass"</code>''' об'єкт, який містить інформацію для формування QR code. У '''<code>instrumentvalue</code>''' буде рядок, з якого потрібно генерувати QR code.
Рядок 28: Рядок 28:
</syntaxhighlight>
</syntaxhighlight>


=== '''Перевірка статусу QR code''' ===
== Перевірка статусу QR code ==
Метод повертає інформацію про поточний статус QR code.
Метод повертає інформацію про поточний статус QR code.
<p style="border: 1px solid deepskyblue; background-color: rgba(135, 206, 235, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 70px;">
<p style="border: 1px solid deepskyblue; background-color: rgba(135, 206, 235, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 70px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: deepskyblue; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">GET</span>
<span style="position: absolute; top: 10px; left: 10px; background-color: deepskyblue; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">GET</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/payment/qrPaymentCheck</span></p>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/payment/qrPaymentCheck</span></p>
====  '''Request''' ====
<syntaxhighlight lang="http" line="1">
headers
'PartnerKey: partnerName'
'locale: ua'
'AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='
queryParams
“orderId”: “string”
</syntaxhighlight>
==== '''Response''' ====
<syntaxhighlight lang="http" line="1">
headers
----
body
{
  "status": "Generated",
  "transactionId": null,
  "error": null
}
</syntaxhighlight>
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-size: 0.85em; color: #333;"
! style="border-bottom: 1px solid #d3d3d3; text-align: left; padding: 10px;" | Параметр
! style="border-bottom: 1px solid #d3d3d3; text-align: left; padding: 10px;" | Характеристика
|-
| style="border-bottom: 1px solid #d3d3d3; padding: 10px; vertical-align: top;" | <code>status</code>
| style="border-bottom: 1px solid #d3d3d3; padding: 10px; vertical-align: top;" |
'''Можливі значення:'''
* <code>Generated</code> — QR згенеровано
* <code>Scanned</code> — QR відскановано
* <code>PaymentStarted</code> — платіж розпочато
* <code>PaymentFinished</code> — платіж завершено
* <code>None</code> — статус відсутній
|-
| style="padding: 10px; vertical-align: top;" | <code>transactionId</code>
| style="padding: 10px; vertical-align: top;" |
Ідентифікатор платежу в системі EasyPay.
|}
== Оплата за QR code ==
Метод для оплати за QR кодом. Працює тільки з QR кодами, які були отримання від EasyPay.
<p style="border: 1px solid deepskyblue; background-color: rgba(135, 206, 235, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 70px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: deepskyblue; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">GET</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/payment/create/qr</span></p>
'''<br>
==== '''Request''' ====
'''<syntaxhighlight lang="http" line="1">
headers
'PartnerKey: partnerName'
'locale: ua'
'AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
body
{
  "qrCode": "string",
  "amount": 1,
  "userPaymentInstrument": {
"instrumentId": 8499910,
"instrumentType": "QrMasterpass",
                "alias": "Mycard",
                "pan": "4102*******4441"
  },
  "resultUrl": "string"
}
</syntaxhighlight>'''
==== '''Response''' ====
<syntaxhighlight lang="http" line="1">
headers
----
body
{
  "paymentState": "Confirmed",
  "status": "Done",
  "retrievalReferenceNo": 11111111,
  "error": null
}
</syntaxhighlight>
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-size: 0.85em; color: #333;"
! style="border-bottom: 1px solid #d3d3d3; text-align: left; padding: 10px;" | Параметр
! style="border-bottom: 1px solid #d3d3d3; text-align: left; padding: 10px;" | Характеристика
|-
| style="border-bottom: 1px solid #d3d3d3; padding: 10px; vertical-align: top;" | <code>'''paymentState'''</code>
| style="border-bottom: 1px solid #d3d3d3; padding: 10px; vertical-align: top;" |
'''Можливі значення:'''
* <code>'''Confirmed'''</code>
* <code>'''Rejected'''</code>
|}

Поточна версія на 13:37, 10 квітня 2026

(Для мерчантів, які мають пряму інтеграцію з MasterPass)

Оплата з гаманця MasterPass із використанням Qr code.

Отримання даних для QR-code

Потрібно створити сесію (для детальної інформації перейдіть за посиланням - Створення сесії). Після цього необхідно створити замовлення (Створення замовлення).

У відповіді в paymentInstrumentsTypes => instrumentType: "QrMasterpass" об'єкт, який містить інформацію для формування QR code. У instrumentvalue буде рядок, з якого потрібно генерувати QR code.


Приклад: paymentInstrumentsTypes => instrumentType: "QrMasterpass"

{
   "instrumentType":"QrMasterpass",
   "commission":0.0,
   "amountMin":1.00,
   "amountMax":14999.00,
   "userPaymentInstruments":[
  	{
     	"instrumentId":8499910,
     	"instrumentType":"QrMasterpass",     	  "instrumentValue":"00020101021252040000530398054034005802UA5909EasyPayUa6004Kiev64190002UK0109EasyPayUa80850017ua.mastercard.www010200020840703434032003434180702054456177041211109354874205020181500017ua.mastercard.www011720191111093548742020499996223030443590603391070410036304AF79",
     	"alias":null,
     	"commission":0.0,
     	"loyaltyCommission":null,
     	"actionsKeys":null,
     	"priorityIndex":0,
     	"additionalParams":{
        	"OrderId":"4825209b-1caa-472e-b530-dc3e8efd541c"
     	}
  	}
   ]
}

Перевірка статусу QR code

Метод повертає інформацію про поточний статус QR code.

GET /api/payment/qrPaymentCheck

Request

headers
'PartnerKey: partnerName' 
'locale: ua'
'AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='

queryParams
“orderId”: “string”

Response

headers
----

body
{
  "status": "Generated",
  "transactionId": null,
  "error": null
}
Параметр Характеристика
status

Можливі значення:

  • Generated — QR згенеровано
  • Scanned — QR відскановано
  • PaymentStarted — платіж розпочато
  • PaymentFinished — платіж завершено
  • None — статус відсутній
transactionId

Ідентифікатор платежу в системі EasyPay.


Оплата за QR code

Метод для оплати за QR кодом. Працює тільки з QR кодами, які були отримання від EasyPay.

GET /api/payment/create/qr


Request

headers
'PartnerKey: partnerName' 
'locale: ua'
'AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d'

body
{
  "qrCode": "string",
  "amount": 1,
  "userPaymentInstrument": {
	"instrumentId": 8499910,
	"instrumentType": "QrMasterpass",
                 "alias": "Mycard",
                 "pan": "4102*******4441"
  },
  "resultUrl": "string"
}

Response

headers
----
body
{
  "paymentState": "Confirmed",
  "status": "Done",
  "retrievalReferenceNo": 11111111,
  "error": null
}
Параметр Характеристика
paymentState

Можливі значення:

  • Confirmed
  • Rejected