# Запит проведення платежу **Вхідні параметри:** | Параметр | Опис | Формат даних | Обов'язковість | Приклад | | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Об’єкт **paymentToken** | | object | Так | | | Об'єкт **paymentData** | | object | Так | | | data |

зашифрований блок даних, який містить деталі платіжної картки, інформацію про транзакцію, суму, валюту тощо

| string | Так | CLtkH05O6bkhXkEdN/0LGtJQGeNT+9PMDp... | | transactionIdentifier | унікальний ідентифікатор транзакції, який генерується Apple Pay для кожного платежу | string | Так | 2d4921ff56bf979b76c53b3... | | signature | підпис, який підтверджує, що дані в полі `data` не були змінені після шифрування | string | Так | MIAGCSqGSIb3DQEHAqCAMIACA... | | version |

версія формату paymentData, яка вказує на специфікацію Apple Pay для зашифрованих даних.

| string | Так | EC\_v1 | | Об'єкт **header** | | object | Так | | | publicKeyHash | хеш відкритого ключа мерчанта, який підтверджує, що дані були зашифровані для конкретного мерчанта | string | Так | 1LSYfOslX5QlRIUAidZju... | | applicationData | додаткові дані, які мерчант хоче передати разом із запитом на оплату | string | Ні | | | wrappedKey | зашифрований симетричний ключ, який використовується для додаткового захисту платіжних даних | string | Ні | MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8... | | ephemeralPublicKey | тимчасовий відкритий ключ, який використовується для шифрування даних | string | Так | MFkwEwYHKoZIzj0CAQYIKoZI.. | | transactionId | унікальний ідентифікатор транзакції | string | Так | 2d4921ff56bf979b76c53b3a.. | | Об'єкт **paymentMethod** | | object | Так | | | displayName | ім'я мерчанта, яке відображається користувачу під час проведення платежу | string | Так | Merchant 5538 | | network | платіжна мережа, яка використовується для транзакції | string | Так | visa, masterCard | | type | тип транзакції, який визначає, як проводиться платіж | string | Так | debit, credit | | Додаткові дані для проведення платежу | | object | | | | 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) | Ні | [![](https://docs.merchant.alb.ua/~gitbook/image?url=https%3A%2F%2Fsupport.google.com%2Ffavicon.ico\&width=300\&dpr=4\&quality=100\&sign=ae88f641\&sv=1)Google Help](https://support.google.com/) | | notificationUrl | url, на який буде відправлено CallBack | string (255) | Ні | [https://merchant.notification\_url](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 | додаткова інформація\коментар мерчанта по замовленню |

tring(255)

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

| Ні | merchant Comment id 1258728c1 | | customerData | об'єкт з customer даними | object | Так | | | senderCustomerId | Id клієнта відправника | string (255) | Так | 1258728c1 | | senderFirstName | ім'я відправника |

string (30)

| Ні | Іваненко | | senderLastName | прізвище відправника |

string (30)

| Ні | Іван | | senderMiddleName | по-батькові відправника |

string (30)

| Ні | Іванович | | senderEmail | пошта відправника | string (256) | Ні | | | 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 | space.vars.senderIP\_description | string (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 | 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 | | | txnType | під тип транзакціі | enum | Можливі значення: NONCVV/noncvv- при отриманні даного значення введення cvv та його перевірка не відбувається | | senderCustomerId | Id клієнта відправника | string | 1258728c1 | | senderFirstName | прізвище відправника | string | Іваненко | | senderLastName | ім'я відправника | string | Іван | | senderMiddleName | по-батькові відправника | string | Іванович | | senderEmail | пошта відправника | string | | | senderCountry | країна відправника | string | Україна | **Приклад тіла запиту** ```json "paymentToken": { "paymentData": { "data": "CLtkH05O6bkhXkEdN/0LGtJQGeNT+9PMDpC0oITlXse1wZby4EtRwNhWz5Cp12ZjKGvsVX0aHeNsyULl8ca3fbVdaYA6b6MGQ7oPBVVyecRo0dl3p8Xhm5oHx9NcI+KTgx2oAZAGxylAAVADKFhYY0xo81yPm8KIhnv8rsKmCyL3d/Vhmlznfr7HgkmmXVhF/YoMp1FDdO6SWQkQBbM8Bu30DQBxPKJAHWGhWTBx8ufWKx+P7ErP2dROhQbFKZEtAvpNOS1o4CV5l4lLfNjiRb+QO85aPbbp80ohD6D9xjCP30lpP8JnWsJIBB3p158SId4Fz95152cvpirqZkOinCfHMLPM371Ent9e50UjQj20d4HVkV6XfwZpRUj8/UYFcemqG+w/VNp7WUFePA==", "signature": "MIAGCSqGSIb3DQEHAqCAMIACAQExDTALBglghkgBZQMEAgEwgAYJKoZIhvcNAQcBAACggDCCA+MwggOIoAMCAQICCBZjTIsOMFcXMAoGCCqGSM49BAMCMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0yNDA0MjkxNzQ3MjdaFw0yOTA0MjgxNzQ3MjZaMF8xJTAjBgNVBAMMHGVjYy1zbXAtYnJva2VyLXNpZ25fVUM0LVBST0QxFDASBgNVBAsMC2lPUyBTeXN0ZW1zMRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABMIVd+3r1seyIY9o3XCQoSGNx7C9bywoPYRgldlK9KVBG4NCDtgR80B+gzMfHFTD9+syINa61dTv9JKJiT58DxOjggIRMIICDTAMBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFCPyScRPk+TvJ+bE9ihsP6K7/S5LMEUGCCsGAQUFBwEBBDkwNzA1BggrBgEFBQcwAYYpaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZWFpY2EzMDIwggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgdGhlIHRoZW4gYXBwbGljYWJsZSBzdGFuZGFyZCB0ZXJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZmljYXRlIHBvbGljeSBhbmQgY2VydGlmaWNhdGlvbiBwcmFjdGljZSBzdGF0ZW1lbnRzLjA2BggrBgEFBQcCARYqaHR0cDovL3d3dy5hcHBsZS5jb20vY2VydGlmaWNhdGVhdXRob3JpdHkvMDQGA1UdHwQtMCswKaAnoCWGI2h0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlYWljYTMuY3JsMB0GA1UdDgQWBBSUV9tv1XSBhomJdi9+V4UH55tYJDAOBgNVHQ8BAf8EBAMCB4AwDwYJKoZIhvdjZAYdBAIFADAKBggqhkjOPQQDAgNJADBGAiEAxvAjyyYUuzA4iKFimD4ak/EFb1D6eM25ukyiQcwU4l4CIQC+PNDf0WJH9klEdTgOnUTCKKEIkKOh3HJLi0y4iJgYvDCCAu4wggJ1oAMCAQICCEltL786mNqXMAoGCCqGSM49BAMCMGcxGzAZBgNVBAMMEkFwcGxlIFJvb3QgQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE0MDUwNjIzNDYzMFoXDTI5MDUwNjIzNDYzMFowejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8BcRhBnXZIXVGl4lgQd26ICi7957rk3gjfxLk+EzVtVmWzWuItCXdg0iTnu6CP12F86Iy3a7ZnC+yOgphP9URaOB9zCB9DBGBggrBgEFBQcBAQQ6MDgwNgYIKwYBBQUHMAGGKmh0dHA6Ly9vY3NwLmFwcGxlLmNvbS9vY3NwMDQtYXBwbGVyb290Y2FnMzAdBgNVHQ4EFgQUI/JJxE+T5O8n5sT2KGw/orv9LkswDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBS7sN6hWDOImqSKmd6+veuv2sskqzA3BgNVHR8EMDAuMCygKqAohiZodHRwOi8vY3JsLmFwcGxlLmNvbS9hcHBsZXJvb3RjYWczLmNybDAOBgNVHQ8BAf8EBAMCAQYwEAYKKoZIhvdjZAYCDgQCBQAwCgYIKoZIzj0EAwIDZwAwZAIwOs9yg1EWmbGG+zXDVspiv/QX7dkPdU2ijr7xnIFeQreJ+Jj3m1mfmNVBDY+d6cL+AjAyLdVEIbCjBXdsXfM4O5Bn/Rd8LCFtlk/GcmmCEm9U+Hp9G5nLmwmJIWEGmQ8Jkh0AADGCAYkwggGFAgEBMIGGMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUwIIFmNMiw4wVxcwCwYJYIZIAWUDBAIBoIGTMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTI0MDkyNTE0NTIxMFowKAYJKoZIhvcNAQk0MRswGTALBglghkgBZQMEAgGhCgYIKoZIzj0EAwIwLwYJKoZIhvcNAQkEMSIEIBpIgKQboEHgDkNYiHuoxqtps5oRjZAr/0YLZmSz2pq6MAoGCCqGSM49BAMCBEgwRgIhAIkjGYfkIWMHGQ4y3xMqF3qvRKc2KwWaqBuTaf8iSlmvAiEAje5izLs9ItZTUCob80n+W3/oOQD0MmdrbIU75mztQ6YAAAAAAAA=", "header": { "publicKeyHash": "1LSYfOslX5QlRIUAidZjuXuz3w3KHgpnF7RZXPOPAbc=", "ephemeralPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAECWpX1FFd7LTXechNBSUtq9OVotLI1zCSgdr5fUWYVt4hJpl1qFSIPPOpbtOhhugrF+ZmZVvbmUe9gNscRUHOtw==", "transactionId": "2d4921ff56bf979b76c53b3a6f79125883546ace6548889a0468209741cc0f33" }, "version": "EC_v1" }, "paymentMethod": { "displayName": "MasterCard 5538", "network": "MasterCard", "type": "debit" }, "transactionIdentifier": "2d4921ff56bf979b76c53b3a6f79125883546ace6548889a0468209741cc0f33" }, "desiredThreeDSMode": "MUST_NOT", "notificationUrl": "https://www.google.com.ua/?hl=ru", "resultRedirectUrl": "https://www.google.com.ua/?hl=ru", "purpose": "purpose", "comment": "comment", "merchantId": "137d9304-0368-11ed-b939-0242ac120002", "merchantRequestId": "d7e27615-4357-4647-a9b8-3488d48be594", "date": "2024-09-25 18:54:37.00+03:00", "customerData": { "senderCustomerId": "1231234124142", "senderFirstName": "John", "senderLastName": "Doe", "senderMiddleName": "Fall", "senderEmail": "test@gmail.com", "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" } } } ``` **Приклад тіла відповіді без 3DS** ```json { "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** ```json { "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 } ```