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

Зміна статусу обробника угоди

Метод для зміни статусу обробника угоди, що призводить до зміни статусу самої угоди. Статус обробника можливо отримати у відповіді при виклику https://uapayua.atlassian.net/wiki/spaces/AC/pages/337379661, в полі - data.handler.status. Змінювати статус обробника угоди можливо лише у випадку, коли в угоді вказано користувацький тип обробника (наприклад data.handler.type=”Custom”) та статус обробника угоди - ‘CREATED', 'SENT' або 'DELIVERED' (це можливо лише після https://uapayua.atlassian.net/wiki/spaces/AC/pages/340623546). А змінити статус можливо лише на 'SENT', 'DELIVERED', 'FINISHED', 'CANCELED', 'REJECTED' або 'EXPIRED'.

Статуси обробника 'FINISHED', 'CANCELED', 'REJECTED' та 'EXPIRED' - фінальні, змінам не підлягають і призводять до зарахування/повернення грошей за товар і доставку.

Запит

Method

PATCH

URL

/handlers/{{handlerType}}/status

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

Поле

Обов'язковість

Тип

Опис

Приклад

Поле

Обов'язковість

Тип

Опис

Приклад

{{handlerType}}

Так

String

Тип обробника

"Custom"

dealId

Так

String

ID угоди

"L8M95ER"

status

Так

String

Статус обробника. Може бути:

  • "SENT" - товар відправлено;

  • "DELIVERED" - товар прибув;

  • "FINISHED" - покупець отримав товар, зараховано гроші за товар і доставку;

  • "CANCELED" - ТТН (або аналог) відмінено чи видалено, повернення грошей за товар і за доставку;

  • "REJECTED" - відмова покупцем від товар, повернення грошей лише за товар;

  • "EXPIRED" - перевищено час очікування для отримання товару, повернення грошей лише за товар

“SENT“

statusCode

Нет

String

Статус код обробника в системі клієнта

“123“

statusText

Нет

String

Текстовий статус обробника в системі клієнта

“Посилка знаходиться в сортувальному центрі“

 

PATCH /handlers/Custom/status
{   "dealId": "L8M95ER",   "status": “SENT“,   "statusCode": “123“,   "statusText": “Посилка знаходиться в сортувальному центрі“ }

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

Поле

Опис

Поле

Опис

data

Об'єкт з відповіддю

data.id

ID угоди

data.externalId

Зовнішній ID угоди

Приклад:

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

 

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