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

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

POST
/api/v1/references/payment-statuses

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

Авторизация

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

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

Тело запроса

application/json
  1. body
name*string

Название, уникально в магазине.

Length1 <= length <= 100
isPaid*boolean

Считать ли заказ в этом статусе оплаченным. По умолчанию false.

Defaultfalse
description?|

Описание.

color?|

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

Ответ

Запись создана.

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

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

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

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

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