Запит проведення платежу Крок 1

{{url}}/ecom/execute_request/payments/v3/apple_pay/purchase

Вхідні JSON параметри:

Параметр	Опис	Формат даних	Обов'язковість	Приклад
Об’єкт paymentData, який необхідно закриптувати платіжним ключем
applicationPrimaryAccountNumber	номер рахунку картки, з якої фінансується ця транзакція	string	Так	4420642424203999
applicationExpirationDate	Термін дії картки у форматі YYMMDD	string	Так	261001
currencyCode	Цифровий код валюти ISO 4217	string	Так	980
transactionAmount	Сума платежу	string	Так	2000
cardholderName	Ім'я власника картки	string	Ні	Іванченко Петро
deviceManufacturerIdentifier	Hex-encoded device manufacturer identifier	string	Так	1
paymentDataType		string	Так	3DSecure
paymentData
onlinePaymentCryptogram	Криптограма платежу у форматі Base64	string	Так	AVn0rK8BiDxN2D/w2j8LMAABAAA=
eciIndicator	ECI indicator	string(1)	Ні	7
Додаткові дані для проведення платежу
merchantRequestId	унікальний ідентифікатор згенерований системою мерчанта, використовується для можливості дізнатися статусоперації якщо запит закінчився невідомою помилкою чи дісконектом	string(36)	Так	137d9304-0368-11ed-b939-0242ac120002
merchantId	Id мерчанту згенерований в Єкомі	string(36)	Так	137d9304-0368-11ed-b939-0242ac120002
desiredThreeDSMode	Ознака яка вказує, чи бажає мерчант використати 3DS в покупці чи ні.	string (50)	Так	За замовчуванням SHOULD
resultRedirectUrl	Url для редиректа клієнта після проходження 3DS аутентифікації	string (1000)	Ні	Google Help
notificationUrl	url, на який буде відправлено CallBack	string (1000)	Ні	https://merchant.notification_url
notificationEncryption	ознака криптування данних CallBack	string	Ні	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
customerData	об'єкт з customer даними	object	Так
senderCustomerId	Id клієнта відправника	string (255)	Так	1258728c1
senderFirstName	ім'я відправника	string (30) значення не може містити виключно цифри не може містити крапки та інші спецсимволи дозволено приймати тільки літерно-цифрові значення може приймати пробіл та дефіс, але НЕ може складатися виключно з “ “ или “-“ дефіс чи пробіл може бути всередині, але не може бути на початку чи кінці Для символу апострофу використовуйте єдиний доступний символ 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)	Ні	[e-mail]
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
senderIp	IP адреса відправника	string (50)	Ні	123.12.12.12
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	https://merchant.notification_url/
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	b6c35fdb-28c1-454d-a2f3-51098c26bda4
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	https://api-ecom-release.develop.bankalliance.ua/threeDS/getRedirectHtml/1702047427621BHu5X99yDbA
txnType	під тип транзакціі	enum	Можливі значення: NONCVV/noncvv- при отриманні даного значення введення cvv та його перевірка не відбувається
senderCustomerId	Id клієнта відправника	string	1258728c1
senderFirstName	прізвище відправника	string	Іваненко
senderLastName	ім'я відправника	string	Іван
senderMiddleName	по-батькові відправника	string	Іванович
senderEmail	пошта відправника	string	[e-mail]
senderCountry	країна відправника	string	Україна

Приклад об’єкту paymentData

{
"applicationPrimaryAccountNumber":"{{applePayCardNumber}}",
"applicationExpirationDate":"{{applePayDate}}",
"currencyCode":"980",
"transactionAmount":"100",
"cardholderName":"{{cardholderName}}",
"deviceManufacturerIdentifier":"1255548888hfhhbbk",
"paymentDataType":"3DSecure",
"paymentData":{
"onlinePaymentCryptogram":"AVn0rK8BiDxN2D/w2j8LMAABAAA=",
"eciIndicator":"7"}
}

Приклад тіла запиту

{
    "paymentData":  "{{encryptedPaymentData}}",
    "merchantRequestId": "{{requestUUIDT}}",
    "desiredThreeDSMode": "MUST_NOT",
    "notificationUrl": "",
    "resultRedirectUrl": "",
    "purpose": "purpose",
    "comment": "comment",
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "customerData": {
        "senderFirstName": "John",
        "senderLastName": "Doe",
        "senderMiddleName": "Fall",
        "senderEmail": "[e-mail]",
        "senderCountry": "sender_country",
        "senderRegion": "sender_region",
        "senderCity": "sender_city",
        "senderStreet": "sender_street",
        "senderAdditionalAddress": "N 6",
        "senderItn": "12345",
        "senderPassport": "12345",
        "senderIp": "165.222.87.224",
        "senderPhone": "380967542344",
        "senderBirthday": "12/12/2000",
        "senderGender": "Male",
        "senderZipCode": "12345"
    },
    "date": "{{currentdateT}}.00+00:00"
}

Приклад тіла відповіді без 3DS

{
    "type": "PURCHASE",
    "rrn": null,
    "purpose": "назначение",
    "comment": "тестовыйкомент",
    "coinAmount": null,
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "operationId": null,
    "ecomOperationId": "459dc6d9-cbcb-4f80-9e96-7c09562f51d9",
    "merchantName": null,
    "approvalCode": null,
    "status": "PENDING",
    "transactionType": 35,
    "merchantRequestId": "afb51fa6-a2ec-4f02-b2d0-3a6efee611f0",
    "transactionCurrency": "980",
    "merchantCommission": null,
    "createDateTime": "2024.09.19 15:29:25.675",
    "modificationDateTime": "2024.09.19 15:29:25.675",
    "transactionResponseInfo": {
        "actionCode": null,
        "responseCode": null,
        "description": null
    },
    "bankCode": null,
    "paymentSystem": null,
    "productType": "PURCHASE",
    "notificationUrl": "https://api-ecom-prod.bankalliance.ua/mock",
    "paymentServiceType": "APPLE_PAY",
    "notificationEncryption": false,
    "cardNumberMask": null,
    "desiredThreeDSMode": "MUST_NOT",
    "threeDSMode": null,
    "statusThreeDs": null,
    "threeDSServerTransId": null,
    "redirect3dsUrl": null,
    "txnType": "null",
    "senderCustomerId": null,
    "senderFirstName": null,
    "senderLastName": null,
    "senderMiddleName": null,
    "senderEmail": null,
    "senderCountry": null,
    "senderRegion": null,
    "senderCity": null,
    "senderStreet": null,
    "senderAdditionalAddress": null,
    "senderItn": null,
    "senderPassport": null,
    "senderIp": null,
    "senderPhone": null,
    "senderBirthday": null,
    "senderGender": null,
    "senderZipCode": null,
    "senderBankCode": null,
    "senderPaymentSystem": null,
    "senderCardNumberMask": null
}

Приклад тіла відповіді з 3DS

{
    "type": "PURCHASE",
    "rrn": null,
    "purpose": "purpose",
    "comment": "comment",
    "coinAmount": null,
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "operationId": "1712824711120IbbgGHLPNCm",
    "ecomOperationId": "895f15f5-26f7-43cd-8cc1-8f970148425b",
    "merchantName": null,
    "approvalCode": null,
    "status": "REQUIRED_3DS",
    "transactionType": 35,
    "merchantRequestId": "4bf82d10-472d-4ac5-b505-4b7d22ba2686",
    "transactionCurrency": "980",
    "merchantCommission": null,
    "createDateTime": "2024.09.19 15:29:25.675",
    "modificationDateTime": "2024.09.19 15:29:25.675",
    "transactionResponseInfo": {
        "actionCode": null,
        "responseCode": null,
        "description": null
    },
    "bankCode": null,
    "paymentSystem": null,
    "productType": "PURCHASE",
    "notificationUrl": "https://api-ecom-prod.bankalliance.ua/mock",
    "paymentServiceType": "APPLE_PAY",
    "notificationEncryption": false,
    "cardNumberMask": null,
    "desiredThreeDSMode": "MUST",
    "threeDSMode": "MUST",
    "statusThreeDs": null,
    "threeDSServerTransId": "0036703b-839f-4166-a1d8-5fe2f6fb2ea8",
    "redirect3dsUrl": null,
    "txnType": "null",
    "senderCustomerId": null,
    "senderFirstName": null,
    "senderLastName": null,
    "senderMiddleName": null,
    "senderEmail": null,
    "senderCountry": null,
    "senderRegion": null,
    "senderCity": null,
    "senderStreet": null,
    "senderAdditionalAddress": null,
    "senderItn": null,
    "senderPassport": null,
    "senderIp": null,
    "senderPhone": null,
    "senderBirthday": null,
    "senderGender": null,
    "senderZipCode": null,
    "senderBankCode": null,
    "senderPaymentSystem": null,
    "senderCardNumberMask": null
}