UAPAY - національний платіжний сервіс

Оновлення угоди

Метод для оновлення угоди. Оновлювати поля угоди можливо лише тоді, коли вона має статус "NEW" або"PAID".

Дозволені поля для оновлення при статусі угоди "NEW": cartIdcartExternalIdproductTitleproductPrice, productWeight, sellerFirstName, sellerLastName, sellerPatronymic, sellerPhone, sellerEmail, buyerFirstName, buyerLastName, buyerPatronymic, buyerPhone, buyerEmail, lg, adId, payment.typepayment.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, sellerEmailpayment.cardToIdhandler.senderFirstName, handler.senderLastName, handler.senderPatronymic, handler.senderPhone, handler.senderEmail, handler.senderOfficeId, handler.recipientFirstName, handler.recipientLastName, handler.recipientPatronymic, handler.recipientPhone, handler.recipientEmail, handler.recipientOfficeId.

Запит

MethodPATCH
URL/deals/{{dealId}}

Параметри запиту

ПолеОбов'язковістьТипОписПриклад
{{dealId}}ТакStringID угоди (або externalId, або byExternalId=true), яку необхідно оновити"L8M95ER"
byExternalIdНіBooleanДля пошуку угоди по externalId потрібно передавати truetrue
adIdНіStringID оголошення, оголошення має бути підтверджено (статус - "CONFIRMED")"A-D7ZL93Z"
cartIdНіNumberID кошику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НіStringID міста в системі обраного обробника, з якогого буде виконана відправка "8d5a980d-391c-11dd-90d9-001a92567626"
handler.senderOfficeIdНіStringID відділення/офісу в системі обраного обробника, з якого буде виконана  відправка

"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НіStringID міста в системі обраного обробника, в яке буде виконана відправка"8d5a980d-391c-11dd-90d9-001a92567626"
handler.recipientOfficeIdНіStringID відділення/офісу  в системі обраного обробника, в яке буде виконана відправка"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.idID угоди
data.externalIdЗовнішній ID угоди

Приклад:

{
    "data": {
        "id": "L8M95ER",
        "externalId": "myExternalId537916"
    }
}

UAPAY - національний платіжний сервіс
pay@uapay.ua