Рефсейлс API
Справочники

Изменить статус оплаты

PATCH
/api/v1/references/payment-statuses/{id}

Меняет переданные поля или отключает статус. Системные статусы не редактируются, только отключаются, если это разрешено. При отключении заказы статуса становятся неоплаченными. Право: references:write.

Авторизация

bearerApiKey
headerАвторизацияBearer <ключ>

Ключ API в заголовке Authorization: Bearer rsk_live_…. Ключ создаёт владелец магазина: Настройки → Интеграции → API-ключи.

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

id*string

ID записи.

Тело запроса

application/json
  1. body
name?string

Новое название. Системные статусы не редактируются.

Length1 <= length <= 100
isPaid?boolean

Считать ли заказ оплаченным.

description?|

Описание. null стирает.

color?|

Цвет метки, #RRGGBB.

isActive?boolean

false отключает статус. Его заказы станут неоплаченными.

Ответ

Запись после изменения.

application/json
  1. response
data*
curl -X PATCH "https://example.com/api/v1/references/payment-statuses/string" \  -H "Content-Type: application/json" \  -d '{    "isActive": false  }'
{  "data": {    "id": "7c1e4a9f-2d6b-4e3a-8f5c-1b9d7e3a6c24",    "code": null,    "name": "Предоплата",    "isPaid": false,    "isActive": true,    "sortOrder": 6  }}

Создать статус оплаты POST

Создаёт статус оплаты. Название уникально в магазине. Право: references:write.

Способы оплаты GET

Способы оплаты, которые магазин включил. id передавайте в paymentTypeId при создании заказа. Список короткий, поэтому приходит одной страницей. Право: references:read.