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

Створення оголошення

Метод для створення оголошення в системі Escrow Box. Оголошення створюється зі статусом "NEW". Оголошення, насамперед, - це предзаповнені поля для угоди. Також є можливість в оголошенні вказати кілька варіантів платіжних систем для оплати товару і декілька варіантів оброблювачів. Оголошення може використовуватися багато разів.

Запит

MethodPOST
URL/ads

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

ПолеОбов'язковістьТипОписПриклад
externalIdНіStringЗовнішній ID, має бути унікальним"myExternalId209081"
sellerFirstNameНіStringІм'я продавця, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд"Іван"
sellerLastNameНіStringПрізвище продавця,  лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд"Іванов"
sellerPatronymicНіStringПо-батькові продавця,  лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд"Іванович"
sellerEmailНіStringЕлектронна пошта продавця"ivanov@mail.test"
sellerPhoneНіStringНомер телефону  продавця в форматі "380XXXXXXXXX""380123456789"
productTitleНіStringНазва товару"Стіл"
productDescriptionНіStringОпис товару"Стіл дубовий, б/в"
productPriceНіNumberЦіна товару в копійках, валюта - гривня, лише цілі числа, більше нуля 100000
productWeightНіNumberВага товару, в грамах, лише цілі числа, більше нуля 15000
handlersConfigsНіArrayМасив можливих об'єктів з даними обробника для цього оголошення
handlersConfigs[].{}.typeНіStringТип обробника, за допомогою якого буде проводитися доставка товару"NovaPoshta"
handlersConfigs[].{}.senderFirstNameНіStringІм'я відправника, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд"Іван"
handlersConfigs[].{}.senderLastNameНіStringПрізвище відправника, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд"Іванов"
handlersConfigs[].{}.senderPatronymicНіStringПо-батькові відправника, лише кирилиця української та російської абетки, а також апостроф. Не дозволяється повторення одного і того самого символу більш ніж 2 рази підряд"Іванович"
handlersConfigs[].{}.senderPhoneНіStringНомер телефону відправника в форматі "380XXXXXXXXX""380123456789"
handlersConfigs[].{}.senderEmailНіStringЕлектронна пошта  відправника"ivanov@mail.test"
handlersConfigs[].{}.senderCityIdНіStringID міста в системі обраного обробника, з якогого буде виконана відправка "8d5a980d-391c-11dd-90d9-001a92567626"
handlersConfigs[].{}.senderOfficeIdНіStringID відділення/офісу в системі обраного обробника, з якого буде виконано відправлення"7b2cc7fd-84ff-11e4-acce-0050568002cf"
paymentsConfigsНіArrayМасив можливих об'єктів з даними платежу за товар для цього оголошення
paymentsConfigs[].{}.typeНіStringТип платіжної системи, за допомогою якої буде проводитися оплата товару"P2P"
paymentsConfigs[].{}.cardToIdНіStringТокен платіжної картки продавця в обраній платіжній системі, на яку будуть зараховані гроші після успішної операції"058a2fa1-8dee-4c39-8796-574cdc573530"

Приклад:

POST /ads
{
  "externalId": "myExternalId209081",
  "sellerFirstName": "Іван",
  "sellerLastName": "Іванов",
  "sellerPatronymic": "Іванович",
  "sellerPhone": "380123456789",
  "sellerEmail": "ivanov@mail.test",
  "productTitle": "Стіл",
  "productDescription": "Стіл дубовий, б/в",
  "productPrice": 100000,
  "productWeight": 15000,
  "handlersConfigs": [
    {
      "type": "NovaPoshta",
      "senderFirstName": "Іван",
      "senderLastName": "Іванов",
      "senderPatronymic": "Іванович",
      "senderPhone": "380987654321",
      "senderEmail": "ivanov@mail.test",
      "senderCityId": "8d5a980d-391c-11dd-90d9-001a92567626",
      "senderOfficeId": "7b2cc7fd-84ff-11e4-acce-0050568002cf"
    }
  ],
  "paymentsConfigs": [
    {
      "type": "P2P",
      "cardToId": "058a2fa1-8dee-4c39-8796-574cdc573530"
    }
  ]
}

Параметри відповіді

ПолеОпис
dataОб'єкт з відповіддю
data.idID оголошення
data.externalIdЗовнішній ID оголошення
data.urlURL на угоду в системі Escrow Box

Приклад:

{
    "data": {
        "id": "A-D7ZL93Z",
        "externalId": "myExternalId209081",
        "url": "https://escrowbox.demo.uapay.ua/ads/A-D7ZL93Z"
    }
}

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