Метод для початку оплати угоди. Почати оплату угоди можна тільки, якщо у неї поточний статус "NEW". Для початку оплати, потрібно щоб такі поля угоди як productPrice, productWeight, buyerPhone були обов'язково заповнені. Також обов'язково на момент оплати повинні бути обрані обробник товару (це поле handler.type) та платіжна система для оплати за товар (це поле payment.type). У свою чергу, в залежності від обраної платіжної системи для оплати платежу за товар обов'язкові поля для заповнення перед початком оплати теж різні, а це призводить до того, що параметри, які передаються в запиті в полі card, також можуть бути різні. Є обов'язкові поля при оплаті і для обробника, вони залежать від обраного обробника.
Обов'язкові поля для платіжних систем:
UAPAY P2P: card.id, card.securityCode, device - передаються в запиті при оплаті угоди, payment.cardToId - вказуються при створенні чи оновленні угоди.
UAPAY ECOM: card.id, card.securityCode, device - передаються в запиті при оплаті угоди.
Обов'язкові поля для обробників:
NovaPoshta: recipientFirstName, recipientLastName, recipientPhone, recipientCityId, recipientOfficeId, senderCityId - вказуються при створенні чи оновленні угоди.
Custom: recipientFirstName, recipientLastName, recipientPhone - вказуються при створенні чи оновленні угоди.
| Method | POST |
| URL | /deals/{{dealId}}/payments |
| Поле | Обов'язковість | Тип | Опис | Приклад |
|---|---|---|---|---|
| {{dealId}} | Так | String | ID угоди (або externalId, якщо byExternalId=true), яку потрібно оплатити | "L8M95ER" |
| byExternalId | Ні | Boolean | Для пошуку угоди по externalId, необхідно передати true | true |
| remoteIP | Так | String | IP-адреса платника | "127.0.0.1" |
| card | Ні | Object | Об'єкт з даними для початку оплати | |
| card.id | Ні | String | Токен платіжної карти платника в обраній платіжній системі | "670ac99a-74d2-4259-b3d5-41907419e4cc" |
| card.securityCode | Ні | String | CVV/CVC код карти платника | "123" |
| device | Так | Object | Об'єкт з інформацією про браузер / пристрій платника | {"acceptHeader":"*/*","ip":"91.137.205.117","colorDepth":24,"javaEnabled":false,"language":"en-US","screenHeight":864,"screenWidth":1536, "windowHeight":734,"windowWidth":1479,"time":"2021-10-07T14:55:52.832Z","timezoneOffset":-180,"userAgent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.159 Safari/537.36"} |
Приклад:
POST /deals/L8M95ER/payments |
{
"remoteIP": "127.0.0.1",
"card": {
"id": "670ac99a-74d2-4259-b3d5-41907419e4cc",
"securityCode": "123"
},
"device": {
"acceptHeader": "*/*",
"ip": "91.137.205.117",
"colorDepth": 24,
"javaEnabled": false,
"language": "en-US",
"screenHeight": 864,
"screenWidth": 1536,
"windowHeight": 734,
"windowWidth": 1479,
"time": "2021-10-07T14:55:52.832Z",
"timezoneOffset": -180,
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.159 Safari/537.36"
}
} |
| Поле | Опис |
|---|---|
| data | Об'єкт з відповіддю |
| data.id | ID платежу, що почав оплату |
| data.type | Тип платіжної системи, з допомогою якої буде виконана оплата |
Приклад:
{
"data": {
"id": "444",
"type": "P2P"
}
} |