UAPAY - національний платіжний сервіс
Оновлення угоди
Метод для оновлення угоди. Оновлювати поля угоди можливо лише тоді, коли вона має статус "NEW" або"PAID".
Дозволені поля для оновлення при статусі угоди "NEW": cartId, cartExternalId, productTitle, productPrice, productWeight, sellerFirstName, sellerLastName, sellerPatronymic, sellerPhone, sellerEmail, buyerFirstName, buyerLastName, buyerPatronymic, buyerPhone, buyerEmail, lg, adId, payment.type, payment.cardToId, handler.type, handler.senderFirstName, handler.senderLastName, handler.senderPatronymic, handler.senderPhone, handler.senderEmail, handler.senderCityId, handler.senderOfficeId, handler.recipientFirstName, handler.recipientLastName, handler.recipientPatronymic, handler.recipientPhone, handler.recipientEmail, handler.recipientCityId, handler.recipientOfficeId.
Дозволені поля для оновлення при статусі угоди "PAID": sellerFirstName, sellerLastName, sellerPatronymic, sellerPhone, sellerEmail, payment.cardToId, handler.senderFirstName, handler.senderLastName, handler.senderPatronymic, handler.senderPhone, handler.senderEmail, handler.senderOfficeId, handler.recipientFirstName, handler.recipientLastName, handler.recipientPatronymic, handler.recipientPhone, handler.recipientEmail, handler.recipientOfficeId.
Запит
Method | PATCH |
URL | /deals/{{dealId}} |
Параметри запиту
Поле | Обов'язковість | Тип | Опис | Приклад |
---|---|---|---|---|
{{dealId}} | Так | String | ID угоди (або externalId, або byExternalId=true), яку необхідно оновити | "L8M95ER" |
byExternalId | Ні | Boolean | Для пошуку угоди по externalId потрібно передавати true | true |
adId | Ні | String | ID оголошення, оголошення має бути підтверджено (статус - "CONFIRMED") | "A-D7ZL93Z" |
cartId | Ні | Number | ID кошику | 338 |
cartExternalId | Ні | String | Зовнішній ID кошику | "myExternalId478454" |
productTitle | Ні | String | Назва товару | "Стіл" |
productWeight | Ні | Number | Вага товару, в грамах, лише цілі числа, більше нуля | 15000 |
productPrice | Ні | Number | Ціна товару в копійках, валюта - гривня, лише цілі числа, більше нуля | 100000 |
sellerFirstName | Ні | String | Ім'я продавця, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд | "Іван" |
sellerLastName | Ні | String | Прізвище продавця, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд | "Іванов" |
sellerPatronymic | Ні | String | По батькові продавця, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд | "Іванович" |
sellerPhone | Ні | String | Номер телефону продавця в форматі "380XXXXXXXXX" | "380123456789" |
sellerEmail | Ні | String | Електронна пошта продавця | "ivanov@mail.test" |
buyerFirstName | Ні | String | Ім'я покупця, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд | "Петро" |
buyerLastName | Ні | String | Прізвище покупця, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд | "Петров" |
buyerPatronymic | Ні | String | По батькові покупця, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд | "Петрович" |
buyerPhone | Ні | String | Номер телефону покупця в форматі "380XXXXXXXXX" | "380987654321" |
buyerEmail | Ні | String | Електронна пошта покупця | "petrov@mail.test" |
payment | Ні | Object | Об'єкт з даними платежу за товар | |
payment.type | Ні | String | Тип платіжної системи, з допомогою якої буде проведено оплату за товар | "P2P" |
payment.cardToId | Ні | String | Токен платіжної картки продавця в обраній платіжній системі, на яку будуть зараховані гроші після успішної операції | "b0be0af6-9c7e-4b62-bf16-9957b34549c9" |
handler | Ні | Object | Об'єкт з даними обробника | |
handler.type | Ні | String | Тип обробника , з допомогою якого буде виконано доставку товару | "NovaPoshta" |
handler.senderFirstName | Ні | String | Ім'я відправника, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд | "Іван" |
handler.senderLastName | Ні | String | Прізвище відправника, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд | "Іванов" |
handler.senderPatronymic | Ні | String | По батькові відправника, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд | "Іванович" |
handler.senderPhone | Ні | String | Номер телефону відправника в форматі "380XXXXXXXXX" | "380987654321" |
handler.senderEmail | Ні | String | Електронна пошта відправника | "ivanov@mail.test" |
handler.senderCityId | Ні | String | ID міста в системі обраного обробника, з якогого буде виконана відправка | "8d5a980d-391c-11dd-90d9-001a92567626" |
handler.senderOfficeId | Ні | String | ID відділення/офісу в системі обраного обробника, з якого буде виконана відправка | "7b2cc7fd-84ff-11e4-acce-0050568002cf" |
handler.recipientFirstName | Ні | String | Ім'я отримувача, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд | "Петро" |
handler.recipientLastName | Ні | String | Прізвище отримувача, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд | "Петров" |
handler.recipientPatronymic | Ні | String | По батькові отримувача, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд | "Петрович" |
handler.recipientPhone | Ні | String | Номер телефону отримувача в форматі "380XXXXXXXXX" | "380987654321" |
handler.recipientEmail | Ні | String | Електронна пошта отримувача | "petrov@mail.test" |
handler.recipientCityId | Ні | String | ID міста в системі обраного обробника, в яке буде виконана відправка | "8d5a980d-391c-11dd-90d9-001a92567626" |
handler.recipientOfficeId | Ні | String | ID відділення/офісу в системі обраного обробника, в яке буде виконана відправка | "1ec09d88-e1c2-11e3-8c4a-0050568002cf" |
Приклад:
PATCH /deals/L8M95ER
{ "adId": "A-D7ZL93Z", "cartId": 338, "productTitle": "Стіл", "productWeight": 15000, "productPrice": 100000, "sellerFirstName": "Іван", "sellerLastName": "Іванов", "sellerPatronymic": "Іванович", "sellerPhone": "380123456789", "sellerEmail": "ivanov@mail.test", "buyerFirstName": "Петро", "buyerLastName": "Петров", "buyerPatronymic": "Петрович", "buyerPhone": "380987654321", "buyerEmail": "petrov@mail.test", "payment": { "type": "P2P", "cardToId": "058a2fa1-8dee-4c39-8796-574cdc573530" }, "handler": { "type": "NovaPoshta", "senderFirstName": "Іван", "senderLastName": "Іванов", "senderPatronymic": "Іванович", "senderPhone": "380987654321", "senderEmail": "ivanov@mail.test", "senderCityId": "8d5a980d-391c-11dd-90d9-001a92567626", "senderOfficeId": "7b2cc7fd-84ff-11e4-acce-0050568002cf", "recipientFirstName": "Петро", "recipientLastName": "Петров", "recipientPatronymic": "Петрович", "recipientPhone": "380987654321", "recipientEmail": "petrov@mail.test", "recipientCityId": "8d5a980d-391c-11dd-90d9-001a92567626", "recipientOfficeId": "1ec09d88-e1c2-11e3-8c4a-0050568002cf" } }
Параметри відповіді
Поле | Опис |
---|---|
data | Об'єкт з відповіддю |
data.id | ID угоди |
data.externalId | Зовнішній ID угоди |
Приклад:
{ "data": { "id": "L8M95ER", "externalId": "myExternalId537916" } }
UAPAY - національний платіжний сервіс
pay@uapay.ua