Возвраты

Download schema

Заявки на возврат оплаты по счёту Kaspi: подать и следить; одобряет лагерь

Заявки на возврат по брони

GET

https://partners.zvezdnyy-burabai.edu.kz/ext/v1

/bookings/{id}/refund-requests

Заявки на возврат по брони › path Parameters

id

string · required

Номер брони

Заявки на возврат по брони › query Parameters

cursor

string

Курсор из next_cursor прошлого ответа

limit

integer · int64 · min: 1 · max: 200

Сколько записей вернуть, 1–200, по умолчанию 50

Default: 50

Заявки на возврат по брони › Responses

Готово

Порция списка. `next_cursor` пуст — дальше ничего нет.

Page_RefundRequest

RefundRequest[] · required

next_cursor

string | null

Передать в cursor, чтобы получить следующую порцию

GET/bookings/{id}/refund-requests

curl https://partners.zvezdnyy-burabai.edu.kz/ext/v1/bookings/:id/refund-requests \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "items": [
    {
      "amount": {
        "amount": "119000.00",
        "currency": "KZT"
      },
      "booking_id": "booking_id",
      "by_api": true,
      "created_at": "2024-08-25T15:00:00Z",
      "decided_at": "2024-08-25T15:00:00Z",
      "finished_at": "2024-08-25T15:00:00Z",
      "id": "41",
      "invoice_id": "invoice_id",
      "payment_id": "payment_id",
      "reason": "reason",
      "refund_payment_id": "refund_payment_id",
      "reject_reason": "reject_reason",
      "state": "requested",
      "version": "version"
    }
  ],
  "next_cursor": "next_cursor"
}

json

application/json

Подать заявку на возврат

POST

https://partners.zvezdnyy-burabai.edu.kz/ext/v1

/bookings/{id}/refund-requests

Просит лагерь вернуть плательщику деньги, пришедшие по счёту Kaspi этой брони. Деньги не двигаются, пока заявку не одобрит сотрудник лагеря; одобрить через API нельзя. Дальше — события refund_request.approved / rejected, затем done (деньги ушли плательщику, рядом приходит payment.refunded) или failed. Возврат уходит через тот же Kaspi лагеря, который принял оплату.

Подать заявку на возврат › path Parameters

id

string · required

Номер брони

Подать заявку на возврат › Headers

Idempotency-Key

string · required

Ключ повтора

Подать заявку на возврат › Request Body

NewRefundRequest

amount

string · pattern: ^[0-9]+(\.0{1,2})?$ · required

Сколько вернуть: тенге строкой, только целые ("30000" или "30000.00"), не больше остатка оплаты за вычетом прежних и ждущих возвратов (refund_exceeds_refundable)

payment_id

string · required

Оплата брони по счёту Kaspi (Payment.id). Оплата другим способом возвращается только лагерем — отказ refund_not_kaspi_invoice

reason

string · required

Почему возвращаем — увидит тот, кто решает. 1–500 знаков

Подать заявку на возврат › Responses

Заявка подана

RefundRequest

Money · required

Деньги: сумма строкой с двумя знаками и валютой. Строкой, а не числом — дробные числа в чужих языках теряют копейки.

booking_id

string · required

by_api

boolean · required

Подана вашим подключением (а не сотрудником лагеря)

created_at

string · date-time · required

id

string · required

invoice_id

string · required

Счёт Kaspi этой оплаты

payment_id

string · required

Оплата по счёту Kaspi, которую возвращают

reason

string · required

state

string · required

requested — ждёт решения лагеря; approved — одобрена, возврат выполняется; sending — отправлен в Kaspi; needs_check — Kaspi не ответил, лагерь проверяет вручную; done — деньги возвращены плательщику; failed — Kaspi отказал, денег не ушло; rejected — лагерь отклонил (причина в reject_reason); cancelled — отозвана автором. Список может пополняться

version

string · required

Версия записи: меняется при каждом изменении заявки

decided_at

string | null · date-time

finished_at

string | null · date-time

refund_payment_id

string | null

Платёж-возврат, записанный по выполненному возврату (done)

reject_reason

string | null

Причина отказа лагеря (только у rejected)

POST/bookings/{id}/refund-requests

curl https://partners.zvezdnyy-burabai.edu.kz/ext/v1/bookings/:id/refund-requests \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "amount": "30000",
  "payment_id": "9120",
  "reason": "Ребёнок заболел, смена отменена"
}'

Example Request Body

{
  "amount": "30000",
  "payment_id": "9120",
  "reason": "Ребёнок заболел, смена отменена"
}

json

Example Responses

{
  "amount": {
    "amount": "119000.00",
    "currency": "KZT"
  },
  "booking_id": "booking_id",
  "by_api": true,
  "created_at": "2024-08-25T15:00:00Z",
  "decided_at": "2024-08-25T15:00:00Z",
  "finished_at": "2024-08-25T15:00:00Z",
  "id": "41",
  "invoice_id": "invoice_id",
  "payment_id": "payment_id",
  "reason": "reason",
  "refund_payment_id": "refund_payment_id",
  "reject_reason": "reject_reason",
  "state": "requested",
  "version": "version"
}

json

application/json

Заявка на возврат

GET

https://partners.zvezdnyy-burabai.edu.kz/ext/v1

/refund-requests/{id}

Заявка на возврат › path Parameters

id

string · required

Номер заявки

Заявка на возврат › Responses

Готово

RefundRequest

Money · required

booking_id

string · required

by_api

boolean · required

Подана вашим подключением (а не сотрудником лагеря)

created_at

string · date-time · required

id

string · required

invoice_id

string · required

Счёт Kaspi этой оплаты

payment_id

string · required

Оплата по счёту Kaspi, которую возвращают

reason

string · required

state

string · required

version

string · required

Версия записи: меняется при каждом изменении заявки

decided_at

string | null · date-time

finished_at

string | null · date-time

refund_payment_id

string | null

Платёж-возврат, записанный по выполненному возврату (done)

reject_reason

string | null

Причина отказа лагеря (только у rejected)

Платежи Выписка Kaspi