# Запит верифікації картки Крок 1 **Вхідні параметри:**
ПараметрОпиcФормат данихОбов'язковістьПриклад
merchantRequestIdунікальний ідентифікатор згенерований системою мерчанта, використовується для можливості дізнатися статусоперації якщо запит закінчився невідомою помилкою чи дісконектомstring(36)Так137d9304-0368-11ed-b939-0242ac120002
merchantIdId мерчанту згенерований в Єкоміstring(36)Так137d9304-0368-11ed-b939-0242ac120002
encryptedCardNumberномер карти зашифрований в JWE за допомогою публічного платіжного ключаstringТак5573670000000304 (розшифрований вигляд)
desiredThreeDSModeознака яка вказує, чи бажає мерчант використати 3DS в покупці чи ні.string (50)Так

За замовчуванням SHOULD

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

  • MUST - мерчант вимагає проведення платежу з 3DS
  • MUST_NOT - примусова операція без 3DS
  • SHOULD - якщо картка підтримує 3DS, то робимо перевірку
notificationUrlurl, на який буде відправлено CallBackstring (255)Ніhttps://merchant.notification_url
notificationEncryptionознака криптування данних CallBackstringНі

true/false

Якщо параметр не передано або передано false, то дані в CallBack будуть не закриптовані

dateдата та час платежуstringТак{{currentdateT}}.00+00:00
commentдодаткова опис операції яку заповнює клієнт мерчантаstring (1000)Ні///5555.25412
purposeпризначення платежу яке заповнює мерчантstring (255)НіЗа товар
merchantCommentдодаткова інформація\коментар мерчанта по замовленню

string(255)

a-zA-Z0-9 ,.;:@#$%'-=+1,256$

Ніmerchant Comment id 1258728c1
resultRedirectUrlUrl для редиректа клієнта після проходження 3DS аутентифікаціїstring (1000)НіGoogle Help
customerDataоб'єкт з customer даними objectТак
senderCustomerIdId клієнта відправникаstring (255)Так1258728c1
senderFirstNameім'я відправника

string (30)

  • значення не може містити виключно цифри
  • не може містити крапки та інші спецсимволи
  • не може містити “NULL”, “3D SECURE”, “SURNAME”, “CARDHOLDER”, ”UNKNOWN”
  • дозволено приймати тільки літерно-цифрові значення
  • може приймати пробіл та дефіс, але НЕ може складатися виключно з “ “ или “-“
  • дефіс чи пробіл може бути всередині, але не може бути на початку чи кінці
  • Для символу апострофу використовуйте єдиний доступний символ utf8 - '
    який в:
    utf 16 - u0027
    utf32 - 00000027
НіІваненко
senderLastNameпрізвище відправника

string (30)

  • значення не може містити виключно цифри
  • не може містити крапки та інші спецсимволи
  • дозволено приймати тільки літерно-цифрові значення
  • може приймати пробіл та дефіс, але НЕ може складатися виключно з “ “ или “-“
  • дефіс чи пробіл може бути всередині, але не може бути на початку чи кінці
  • Для символу апострофу використовуйте єдиний доступний символ utf8 - '
    який в:
    utf 16 - u0027
    utf32 - 00000027
НіІван
senderMiddleNameпо-батькові відправника

string (30)

  • значення не може містити виключно цифри
  • не може містити крапки та інші спецсимволи
  • дозволено приймати тільки літерно-цифрові значення
  • може приймати пробіл та дефіс, але НЕ може складатися виключно з “ “ или “-“
  • дефіс чи пробіл може бути всередині, але не може бути на початку чи кінці
  • Для символу апострофу використовуйте єдиний доступний символ utf8 - '
    який в:
    utf 16 - u0027
    utf32 - 00000027
НіІванович
senderEmailпошта відправника string (256)Ніmail@gmail.com
senderСountryкраїна відправникаstring (3) ISO 3166, 804 (Ukraine)Ні804
senderRegionобласть відправникаstring (255)НіКиївська
senderСityмісто відправникаstring (25)НіКиїв
senderStreetвулиця відправникаstring (35)НіСічових стрільців
senderAdditionalAddressдодаткові дані адреси відправника (поверх, номер дому, квартира)string (255)Ні23
senderItnіпн відправникаstring (20)Ні123456789
senderPassportпаспорт відправникаstring (255)НіАН123456
senderIpspace.vars.senderIP_descriptionstring (50)Ніspace.vars.senderIP_example
senderPhoneномер телефону відправникаstring (20)Ні380630000000
senderBirthdayдень народження відправникаstring (50)Ні31.12.2000
senderGenderГендер відправникаstring (50)НіMale/Female
senderZipCodeІндекс відправникаstring (50)Ні 49000
**Вихідні параметри:** | Параметр | Опис | Формат даних | Приклад | | ----------------------- | ------------------------------------------------------------------------ | ------------ | ------------------------------------------------------------------------------------------------------------- | | type | тип транзакції | string | Purchase | | rrn | rrn номер транзакції в МПС | string | 2554256963 | | purpose | призначення платежу | string | За товар | | comment | коментар | string | тест | | coinAmount | сума платежу | int | 2000 | | merchantId | Id мерчанту | string | 137d9304-0368-11ed-b939-0242ac120002 | | operationId | Id транзакціі | string | 1712844596346b9F-WwrWZpq | | ecomOperationId | Id транзакціі в системі Ecom | string | 8c3303e9-7396-43b8-af4e-31d9facdde9b | | merchantName | найменування торговця | string | KB test terminal | | approvalCode | код авторизаціі | string | 39203 | | status | статус транзакціі | string | SUСCESS FAIL PENDING REQUIRED\_3DS DESIRED\_THREEDS\_MODE\_ERROR | | transactionType | тип транзакції у цифровому значенні | string | 35 | | merchantRequestId | Id запиту мерчанта | string | 72837906-f526-4aef-8d11-58d80b44cb75 | | transactionCurrency | валюта платежу | string | 980 | | merchantCommission | сума комісії | string | 2 | | createDateTime | дата створення платежу | string | 2024.09.19 15:29:25.675 | | modificationDateTime | дата модифікаціі платежу | string | 2024.09.19 15:29:25.675 | | actionCode | код відповіді | string | 0 | | responseCode | деталі відповіді | string | 0 | | description | опис відповіді | string | approved | | bankCode | назва банку емітента | string | BANK\_ALLIANCE | | paymentSystem | назва мпс емітента | string | MasterCard | | productType | тип продукту термінала | string | PURCHASE | | notificationUrl | url, на який відправлено CallBack | string | | | paymentServiceType | тип оплати | string | CARD/APPLE\_PAY/GOOGLE\_PAY | | notificationEncryption | ознака криптування данних CallBack | string | true/false Якщо параметр не передано або передано false, то дані в CallBack будуть не закриптовані | | cardNumberMask | маскований номер карти | string | 5573\*\*\*\*\*\*\*\*0304 | | desiredThreeDSMode | ознака яка вказує, чи бажає мерчант використати 3DS в покупці чи ні. | string | MUST/SHOULD/MUST\_NOT | | threeDSMode | параметр який вказує, використовувася 3DS у покупці чи ні | string | MUST- проводимо оплату з 3DS MUST\_NOT- проводимо оплату без 3DS | | statusThreeDs | статус проведення 3DS | string | Y - успіший 3ds N - не успішний 3ds | | threeDSServerTransId | Id транзакціі в системі 3ds | string | 8a811df4-91e0-436b-a9ac-9b0772c96f28 | | acsTransId | Id транзакціі в системі ACS | string | 3e17fabb-71e6-498e-8794-ef8c95c5ba6f | | dsTransId | Id транзакціі згенерований Directory Server | string | 12ebc556-82d3-4e35-9fb8-77ac18b050ea | | eci | Electronic Commerce Indicator Код, який вказує рівень безпеки транзакції | string | 02 | | processingMerchantId | Id мерчанту в ПЦ | string | AE100000 | | processingTerminalId | Id терміналу в ПЦ | string | AE100000 | | redirect3dsUrl | url для редиректа клієнта на сторінку емітента для проходження 3DS | string | | | txnType | під тип транзакціі | enum | Можливі значення: NONCVV/noncvv- при отриманні даного значення введення cvv та його перевірка не відбувається | | senderCustomerId | Id клієнта відправника | string | 1258728c1 | | senderFirstName | ім'я відправника | string | Іваненко | | senderLastName | прізвище відправника | string | Іван | | senderMiddleName | по-батькові відправника | string | Іванович | | senderEmail | пошта відправника | string | | | senderCountry | країна відправника | string | Україна | | senderRegion | область відправника | string | Київська | | senderCity | місто відправника | string | Київ | | senderStreet | вулиця відправника | string | Січових стрільців | | senderAdditionalAddress | додаткові дані адреси відправника (поверх, номер дому, квартира) | string | 23 | | senderItn | іпн відправника | string | 123456789 | | senderPassport | паспорт відправника | string | АН123456 | | senderIp | space.vars.senderIP\_description | string | space.vars.senderIP\_example | | senderPhone | номер телефону відправника | string | 380630000000 | | senderBirthday | день народження відправника | string | 31.12.2000 | | senderGender | гендер відправника | string | M | | senderZipCode | індекс відправника | string | 12000 | | senderBankCode | назва банку емітента відправника | string | BANK\_ALLIANCE | | senderPaymentSystem | назва мпс емітента відправника | string | MasterCard | | senderCardNumberMask | маскований номер карти відправника | string | 5573\*\*\*\*\*\*\*\*0304 | **Приклад тіла запиту** ```json { "merchantId": "137d9304-0368-11ed-b939-0242ac1200", "merchantRequestId": "8c1f4b28-5b96-4b0e-bdc6-1d1cc2f2c42a", "encryptedCardNumber": "", "merchantComment": "", "comment": "", "purpose": "", "resultRedirectUrl": "https://support.google.com/websearch/answer/463?hl=ru", "desiredThreeDSMode": "MUST", "notificationUrl": "https://webhook.site/739593ac-8e50-48fd-a6c4-0422f9487a6e", "notificationEncryption": false, "date": "2025-04-03 14:55:14.00+00:00", "customerData": { "senderCustomerId": "senderCustomerId", "senderLastName": "senderLastName", "senderEmail": "aaaa@gmail.com", "senderFirstName": "senderFirstName", "senderMiddleName": "senderMiddleName", "senderRegion": "senderRegion", "senderCountry": "804", "senderAdditionalAddress": "senderAdditionalAddress", "senderStreet": "senderStreet", "senderCity": "senderCity", "senderIp": "55.555.44", "senderBirthday": "senderBirthday", "senderGender": "senderGender", "senderZipCode": "senderZipCode", "senderPassport": "senderPassport", "senderItn": "senderItn", "senderPhone": "senderPhone" } } ``` **Приклад тіла відповіді без 3DS** ```json { "type": "VERIFICATION", "purpose": "", "comment": "", "coinAmount": 0, "merchantId": "137d9304-0368-11ed-b939-0242ac1200", "operationId": "17436921182614gyGFwqQKlb", "ecomOperationId": "71baa5d2-d685-4f1e-9b44-3b1e747855dc", "status": "PENDING", "transactionType": 215, "merchantRequestId": "8c1f4b28-5b96-4b0e-bdc6-1d1cc2f2c42a", "transactionCurrency": "980", "creationDateTime": "2025.04.03 17:55:18.214", "modificationDateTime": "2025.04.03 17:55:18.214", "transactionResponseInfo": {}, "productType": "PURCHASE", "notificationUrl": "https://webhook.site/739593ac-8e50-48fd-a6c4-0422f9487a6e", "paymentServiceType": "CARD", "notificationEncryption": false, "processingTerminalId": "AE001001", "processingMerchantId": "AE001001", "creatorSystem": "H2H", "desiredThreeDSMode": "MUST", "threeDSMode": "MUST", "threeDSServerTransId": "6c187d07-e46e-4683-930c-8e8312433130", "senderCustomerId": "1234", "senderFirstName": "senderFirstName", "senderLastName": "senderLastName", "senderMiddleName": "senderMiddleName", "senderEmail": "aaaa@gmail.com", "senderCountry": "804", "senderRegion": "senderRegion", "senderCity": "senderCity", "senderStreet": "senderStreet", "senderAdditionalAddress": "senderAdditionalAddress", "senderItn": "5555555", "senderPassport": "passport", "senderIp": "55.555.44", "senderPhone": "5555", "senderBirthday": "20000110", "senderGender": "Female", "senderZipCode": "12345" } ``` **Приклад тіла відповіді з 3DS** ```json { "type": "VERIFICATION", "purpose": "", "comment": "", "coinAmount": 0, "merchantId": "137d9304-0368-11ed-b939-0242ac1200", "operationId": "17436921182614gyGFwqQKlb", "ecomOperationId": "71baa5d2-d685-4f1e-9b44-3b1e747855dc", "status": "REQUIRED_3DS", "transactionType": 215, "merchantRequestId": "8c1f4b28-5b96-4b0e-bdc6-1d1cc2f2c42a", "transactionCurrency": "980", "creationDateTime": "2025.04.03 17:55:18.214", "modificationDateTime": "2025.04.03 17:55:18.214", "transactionResponseInfo": {}, "productType": "PURCHASE", "notificationUrl": "https://webhook.site/739593ac-8e50-48fd-a6c4-0422f9487a6e", "paymentServiceType": "CARD", "notificationEncryption": false, "processingTerminalId": "AE001001", "processingMerchantId": "AE001001", "creatorSystem": "H2H", "desiredThreeDSMode": "MUST", "threeDSMode": "MUST", "threeDSServerTransId": "6c187d07-e46e-4683-930c-8e8312433130", "senderCustomerId": "1234", "senderFirstName": "senderFirstName", "senderLastName": "senderLastName", "senderMiddleName": "senderMiddleName", "senderEmail": "aaaa@gmail.com", "senderCountry": "804", "senderRegion": "senderRegion", "senderCity": "senderCity", "senderStreet": "senderStreet", "senderAdditionalAddress": "senderAdditionalAddress", "senderItn": "5555555", "senderPassport": "passport", "senderIp": "55.555.44", "senderPhone": "5555", "senderBirthday": "20000110", "senderGender": "Female", "senderZipCode": "12345" } ```