УКР | [ENG](https://hackmd.io/MUZzd3mTRQeQfBsE-emVVQ)
:arrow_left: [На Головну](/Mj2ZqCVpSq6A6Jzm6ladlw)

# [10102] Карта-гаманець

*Що таке "оплата картою Server-Server" та як проходить автентифікація відправника див. у розділі ["Оплата картою Server-Server"](https://hackmd.io/oXcYbY08Tq69ggTIX9OyaA).*

## Запит

*Опис атрибутів "Partner", "KeyAES" та "Sign" див. у розділі ["Загальна інформація по підключенню (API)"](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA).*

### Структура "Data"

Структура "Data" для даної операції формується з наступних параметрів:

:::info
<details>
<summary>Формування структури "Data" (приклади наведені нижче)</summary>
<br>

**Схема руху коштів:** "SenderCard" -> RecipientWallet" -> "Wallet".
~~~
{
"GoogleToken/AppleToken": "",
"Currency": "",
"Purpose": "",
"site": "",
"Order": "",
"Wallet": {
"ID": "",
"UserName": ""
},
"TransferC2W": {
"Sum": ,
"SenderCard": {
"PAN": "",
"ExpMon": "",
"ExpYear": "",
"CVV": "",
"Cryptogram": "",
"Gateway": "",
"eciIndicator": ""
},
"RecipientWallet": {
"ID": "",
"UserName": ""
},
"SuccessCallback": "",
"FailedCallback": "",
"CallbackURL": ""
},
"MIDs": [
{
"MID": ,
"Sum": ,
"PaymentInfo": [
{
"Caption": "",
"Value": ""
}
]
}
],
"Transaction": {
"TransactionID": "",
"TerminalID": "",
"DateTime": ""
},
"BrowserData": {
"device": {
"channel": ""
},
"browserIP": "",
"browserTZ": ,
"browserLanguage": "",
"browserUserAgent": "",
"browserColorDepth": ,
"browserJavaEnabled": ,
"browserScreenWidth": ,
"browserScreenHeight": ,
"fraudhuntFingerprint": ""
}
}
~~~
</details>
:::

|Параметр|Обов'яз-ковість|Тип|Опис|Приклад|
|:----:|:----:|:----:|----|:----:|
|`GoogleToken/AppleToken`|Ні|Рядок|Токен картки відправника, що передається при оплаті методом "Google/Apple Pay". |`24iOiJFQ3YyI-UwMDNk9In0...`|
| `Currency` | Так - при оплаті у валюті, відмінній від UAH | Рядок | Код валюти списання – скорочене буквене позначення валюти, описане в стандарті [ISO 4217](https://uk.wikipedia.org/wiki/%D0%9A%D0%BB%D0%B0%D1%81%D0%B8%D1%84%D1%96%D0%BA%D0%B0%D1%86%D1%96%D1%8F_%D0%B2%D0%B0%D0%BB%D1%8E%D1%82_(ISO_4217)) (“GBP”, “USD” та ін.). |`USD`|
|`Purpose`|Ні|Рядок|Опис призначення платежу.|`Оплата замовлення №333`|
|`site`|Ні|Рядок|Назва сайту, з якого здійснюється оплата.|`https://www.xpay.com.ua/`|
| `Order` | Ні | Рядок |Номер замовлення. |`1234А`|
|`Wallet`^1^|Ні|Структура|Структура, що передає дані гаманця підсумкового одержувача (мерчанта) коштів у системі Оператора.|Див. нижче.|
|`TransferC2W`^2^|Так|Структу|Структура, що передає дані про операцію.|Див. нижче.|
| `MIDs`^4^ | Ні | Масив | Масив, що передає дані для розщеплення прийнятого платежу на користь мерчантів. |Див. приклад нижче.|
|`BrowserData`|Ні|Структура|Структура, що передає дані браузера при *3DSecure 2.0*. Див. розділ ["Структура "BrowserData"](https://hackmd.io/oXcYbY08Tq69ggTIX9OyaA?both#%D0%A1%D1%82%D1%80%D1%83%D0%BA%D1%82%D1%83%D1%80%D0%B0-%E2%80%9CBrowserData%E2%80%9D).|Див. приклад у розділі ["Структура "BrowserData"](https://hackmd.io/oXcYbY08Tq69ggTIX9OyaA?both#%D0%A1%D1%82%D1%80%D1%83%D0%BA%D1%82%D1%83%D1%80%D0%B0-%E2%80%9CBrowserData%E2%80%9D).|
|`Transaction`|Так|Структура|Структура, що передає дані про транзакцію. Див. розділ ["Структура "Transaction"](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA#2-Data).|Див. нижче.|

^1^ Параметри структури **"Wallet":**

| Параметр | Обов'яз-ковість | Тип | Опис | Приклад|
|:----:|:----:|:----:|----|:----:|
|`ID`|Так|Рядок|Ідентифікатор гаманця, яким може виступати: </br> - номер телефону, </br> - email, </br> - унікальний ідентифікатор клієнта в системі Партнера, </br> - номер картки клієнта.| `[e-mail]`|
|`UserName`|Ні|Рядок|Назва власника гаманця.|`267608990`|

^2^ Параметри структури **"TransferC2W"**:

| Параметр | Обов'яз-ковість | Тип | Опис | Приклад|
|:----:|:----:|:----:|----|:----:|
|`Sum`|Так|Ціле|Сума операції у копійках. |1грн.=>`100`|
|`SenderCard`^3^|Так|Структура|Структура, що передає дані банківської картки відправника.|Див. нижче.|
|`RecipientWallet`|Так|Структура|Структура, що передає дані гаманця користувача у системі Оператора. Параметри аналогічні структурі "Wallet": `ID` та `UserName`.|Див. нижче.|
| `SuccessCallback` | Ні | Рядок | URL (server), що викликається у разі успішного проведення операції. Див. розділ ["Оплата картою Server-Server"](https://hackmd.io/oXcYbY08Tq69ggTIX9OyaA?both#%D0%A0%D0%B5%D0%B4%D0%B8%D1%80%D0%B5%D0%BA%D1%82-%D0%BA%D0%BB%D1%96%D1%94%D0%BD%D1%82%D0%B0-%D0%BD%D0%B0-%D1%81%D1%82%D0%BE%D1%80%D1%96%D0%BD%D0%BA%D1%83-CallbackURL). |`https://partner.host/cb_success`|
| `FailedCallback` | Ні | Рядок | URL (server), що викликається у разі помилки проведення операції. Див. розділ ["Оплата картою Server-Server"](https://hackmd.io/oXcYbY08Tq69ggTIX9OyaA?both#%D0%A0%D0%B5%D0%B4%D0%B8%D1%80%D0%B5%D0%BA%D1%82-%D0%BA%D0%BB%D1%96%D1%94%D0%BD%D1%82%D0%B0-%D0%BD%D0%B0-%D1%81%D1%82%D0%BE%D1%80%D1%96%D0%BD%D0%BA%D1%83-CallbackURL). |`https://partner.host/cb_fail`|
| `CallbackURL` | Ні | Рядок | URL адреса, на яку буде перенаправлений клієнт після завершення оплати. Див. розділ ["Оплата картою Server-Server"](https://hackmd.io/oXcYbY08Tq69ggTIX9OyaA?both#%D0%A0%D0%B5%D0%B4%D0%B8%D1%80%D0%B5%D0%BA%D1%82-%D0%BA%D0%BB%D1%96%D1%94%D0%BD%D1%82%D0%B0-%D0%BD%D0%B0-%D1%81%D1%82%D0%BE%D1%80%D1%96%D0%BD%D0%BA%D1%83-CallbackURL). |`https://partner.host/resul_page`|

^3^ Параметри структури **“SenderCard”**:

| Параметр | Обов'яз-ковість | Тип | Опис | Приклад|
|:----:|:----:|:----:|----|:----:|
|`PAN`|Так|Рядок[16]| PAN картки (номер банківської карти).| `8888888888888888` |
|`ExpMon`|Так|Рядок[2]|Місяць терміну дії картки. Параметр вирівнюється до 2-х знаків символом "0".|`02`|
|`ExpYear`|Так|Рядок[2]|Останні 2 цифри року терміну дії картки. Параметр вирівнюється до 2-х знаків символом "0".|`22`|
|`CVV`|Ні, якщо передається параметр `Cryptogram`.|Рядок[3]|CVV код картки.|`356`|
|`Cryptogram`|Ні|Рядок|Криптограма розшифрованого токена "Google/Apple Pay". Криптограма - динамічний одноразовий код кожної транзакції, що супроводжує токен. |`AFYjls2Of..XFAoABFA==`|
|`Gateway`|Так, якщо передається параметр `Cryptogram`.|Рядок|Шлюз токенізації "Google/Apple Pay". Передається лише, якщо дані картки були отримані в результаті розшифровування даних.|`gpay` або `applepay`|
|`eciIndicator`|Так, якщо передається параметр `Cryptogram`.|Рядок| [ECI-індикатор](https://developer.visa.com/request_response_codes#moto_eci_ind_codes), значення якого береться з розшифрованої криптограми "Google/Apple Pay". |`7`|

^4^ Параметри масиву **"MIDs"**:

| Параметр | Обов’яз-ковість | Тип | Опис | Приклад |
|:-:|:-:|:-:|-|:-:|
| `MID` |Так| Ціле | Ідентифікатор мерчанта в системі Оператора (Merchant ID), на який зараховуються кошти. |`111`|
| `Sum` |Так| Ціле | Сума платежу у копійках.|1грн.=>`100` |
| `PaymentInfo` | Ні | Масив | Параметр передається для відображення деталей платежу на сторінці оплати. |Див. приклад нижче.|

:::success
<details>
<summary>Приклад структури "Data"</summary>
<br>

~~~md
{
"GoogleToken/AppleToken": "24iOiJFQ3YyI-UwMDNk9In0...",
"Currency": "USD",
"Purpose": "Оплата замовлення №333",
"site": "https://www.xpay.com.ua/",
"Order": "1234А",
"Wallet": {
"ID": "[e-mail]",
"UserName": "267608990"
},
"TransferC2W": {
"Sum": 52500,
"SenderCard": {
"PAN": "0000000000000000",
"ExpMon": "11",
"ExpYear": "22"
},
"RecipientWallet": {
"ID": "[e-mail]",
"UserName": "267608990"
},
"CallbackURL": "https://provider.com/process/index/gateId/16/actionId/267608990/lang/uk/h/e09755bb8352f62b7cc0defb574e5b78a2a3db49cdece328a8e9d2861c46dd9ada04e10df873b63f2277cb988755d562",
"FailedCallback": "https://provider.com/api/merchant/result/21?PaysystemId=35&actionId=267608990",
"SuccessCallback": "https://provider.com/api/merchant/result/21?PaysystemId=35&actionId=267608990"
},
"MIDs": [
{
"MID": 111,
"Sum": 100,
"PaymentInfo": [
{
"Caption": "Призначення",
"Value": "Погашення за контрактом №3642989012-5 від 03.04.2021 Пупкіна Валерія Сергіївна"
}
]
},
{
"MID": 112,
"Sum": 200,
"PaymentInfo": [
{
"Caption": "Призначення",
"Value": "Погашення за контрактом №3642989012-5 від 03.04.2021 Пупкіна Валерія Сергіївна"
}
]
}
],
"Transaction": {
"DateTime": "20220504 08:14:07",
"TerminalID": "802",
"TransactionID": "267608990"
}
}
~~~
</details>
:::

## Відповідь

*Загальна інформація по формуванню структури відповіді наведена у розділі [“Загальна інформація по підключенню (API)”](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA?both#%D0%A1%D1%82%D1%80%D1%83%D0%BA%D1%82%D1%83%D1%80%D0%B0-%D0%B2%D1%96%D0%B4%D0%BF%D0%BE%D0%B2%D1%96%D0%B4%D1%96).*

### Приклади відповідей

:::success
<details>
<summary>Запит успішно прийнятий та вимагає підтвердження "3DS"</summary>
<br>

~~~md
{
"Code": 102,
"Message": "need3ds",
"Data": {
"OperationID": 111,
"3dsHtml": "<html сторінка у кодуванні base64>",
"OperationStatus": 2
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

:::success
<details>
<summary>Запит успішно прийнятий та вимагає підтвердження "OTP"</summary>
<br>

~~~md
{
"Code": 102,
"Message": "needOTP",
"Data": {
"OperationID": 111,
"otpJson": "<JSON структура у вигляді рядка>",
"OperationStatus": 3
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

:::success
<details>
<summary>Операція проведена успішно</summary>
<br>

~~~md
{
"Code": 200,
"Message": "done",
"Data": {
"OperationID": 555,
"OperationStatus": 10
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

:::success
<details>
<summary>Помилка виконання операції</summary>
<br>

~~~md
{
"Code": 200,
"Message": "done",
"Data": {
"OperationID": 111,
"OperationStatus": 21,
"Reason": 3
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

## Тестові дані

:::info

Для тестування даного запиту застосовуйте параметри **Тестового Партнера**.
Див. деталі підключення у розділі: ["Параметри підключення Тестового Партнера"](https://hackmd.io/kGejjgk0QaiwfpoZFnTadA).

<details>
<summary>Тестовий запит</summary>
<br>

~~~md
{
"Partner": {
"PartnerToken": "72a8ddb8-9145-4a41-af1a-8c48ecaa4be1",
"OperationType": 10102
},
"Data": "{\"GoogleToken/AppleToken\":\"24iOiJFQ3YyI-UwMDNk9In0...\",\"Currency\":\"UAH\",\"Purpose\":\"Оплатазазамовлення№12\",\"site\":\"https://www.xpay.com.ua/\",\"Wallet\":{\"ID\":\"[e-mail]\",\"UserName\":\"267608990\"},\"TransferC2W\":{\"Sum\":15300,\"SenderCard\":{\"PAN\":\"8888888888888888\",\"ExpMon\":\"12\",\"ExpYear\":\"24\",\"CVV\":\"356\",\"Cryptogram\":\"AFYjls2Of..XFAoABFA==\",\"Gateway\":\"applepay\"},\"RecipientWallet\":{\"ID\":\"[e-mail]\",\"UserName\":\"budanov.ze1991\"},\"SuccessCallback\":\"https://partner.host/cb_success\",\"FailedCallback\":\"https://partner.host/cb_fail\",\"CallbackURL\":\"https://partner.host/resul_page\"},\"Transaction\":{\"TransactionID\":\"8dвd1fa43331wwfff355\",\"TerminalID\":\"802\",\"DateTime\":\"2023030215:46:27\"},\"BrowserData\":{\"device\":{\"channel\":\"BRW\"},\"browserIP\":\"89.68.252.11\",\"browserTZ\":180,\"browserLanguage\":\"UA\",\"browserUserAgent\":\"Chrome/100.0.4896.127\",\"browserColorDepth\":24,\"browserJavaEnabled\":false,\"browserScreenWidth\":1920,\"browserScreenHeight\":1080,\"fraudhuntFingerprint\":\"kHqPGWS1Mj18sZFsP8Wl\"}}",
"KeyAES": "",
"Sign": ""
}
~~~
</details>

<details>
<summary>Очікувана відповідь</summary>
<br>

~~~md
{
"Code": 102,
"Message": "needACS",
"Data": {
"3dsHtml": "PCFET0NUWVBFIGh0bWwgUFVCTElDICItLy9XM0MvL0RURCBIVE1MIDQuMDEgVHJhbnNpdGlvbmFsLy9FTiIKCSJodHRwOi8vd3d3LnczLm9yZy9UUi9odG1sNC9sb29zZS5kdGQiPgoJPGh0bWw+Cgk8aGVhZD4KCSA8dGl0bGU+WFBBWSB0ZXN0IDNkczwvdGl0bGU+Cgk8L2hlYWQ+Cgk8Ym9keT4KICAgCgkgPGZvcm0gYWN0aW9uPSdodHRwczovL3N0YWdlLWNiMS54cGF5LmNvbS51YS9kdW1tZXJjYjNkcy8xMjgzMTM1OC85NDkyMTA4L0oyZzdEY2kzTVN5Zy9zbXAvc3VjYycgbWV0aG9kPSdHRVQnPgoJIDxwIHN0eWxlPSJ0ZXh0LWFsaWduOiBjZW50ZXIiPgoJIDxidXR0b24+TWFrZSBTVUNDRVNTPC9idXR0b24+CgkgPC9wPgoJIDwvZm9ybT4KICAgCgkgPGZvcm0gYWN0aW9uPSdodHRwczovL3N0YWdlLWNiMS54cGF5LmNvbS51YS9kdW1tZXJjYjNkcy8xMjgzMTM1OC85NDkyMTA4L0oyZzdEY2kzTVN5Zy9zbXAvZmFpbCcgbWV0aG9kPSdHRVQnPgoJIDxwIHN0eWxlPSJ0ZXh0LWFsaWduOiBjZW50ZXIiPgoJIDxidXR0b24+TWFrZSBGQUlMPC9idXR0b24+CgkgPC9wPgoJIDwvZm9ybT4KICAgCgk8L2JvZHk+CiAgIDwvaHRtbD4=",
"LongPollerID": "9492108",
"OperationID": 9492108,
"OperationStatus": 2
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

## Пов'язані запити

[[10101] Карта-карта](https://hackmd.io/ZpBbYAb4RsaTc8NU_0zwfA)
[[10103] Карта-IBAN фізична особа](https://hackmd.io/mQFXiO1USRuVX2-ah4h1FQ)
[[101031] Карта-IBAN юридична особа](https://hackmd.io/-jgdOWRiRwaabSv5_YjAKQ)
[[10150/10051] Карта-телефон-карта](https://hackmd.io/rXZuYXYwQp2W-QffXO99yA)

**Оплата по токену**

[[104021] Оплата картою по токену](https://hackmd.io/CCEZ0su4T3OBtY-_QBSzew)
[[104121] Автосписання з карти по токену (МОТО-операції)](https://hackmd.io/-_Rj-iqZTMy22FxFgUc08w)

**Отримання даних карти**

[[20400/20410] Отримання даних карти за номером телефону](https://hackmd.io/EjF35e_sSfKad2ojsEoYWQ)
[[20404] Отримання даних карти за токеном](https://hackmd.io/Fo0-oeZ4Sz-Gju6Qg01hiA)

**Отримання даних по проведеній операції**
[[20003] Отримання статусу операції](https://hackmd.io/fvd8btZLQXywluia6w5uxg)

**Повернення коштів**
[[30201] Відміна/повернення платежу, здійсненого через API запит](https://hackmd.io/W25MdduPQFidcqLdTWIbpg)

## Довідкові матеріали

Опис загальних параметрів системи XPAY див. у розділі ["Довідкові матеріали"](https://hackmd.io/aBE7H5cfQ-iqaN3SnwaQ-w): коди типів операцій, типи платіжних методів, коди статусів обробки операцій, відомості та помилки, що повертаються у відповіді та ін.

:arrow_left: [На Головну](/Mj2ZqCVpSq6A6Jzm6ladlw)
:arrow_left: [Загальна інформація по підключенню (API)](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA)

<details>
<summary>Служба підтримки XPAY</summary>
</br>

Телефон: [phone]
Email: [e-mail]
Telegram: @xpaysupportbot
</details>