> For the complete documentation index, see [llms.txt](https://docs.plazaworld.pw/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.plazaworld.pw/models.md).

# Models

## The Error object

```json
{"openapi":"3.1.0","info":{"title":"PlazaWorld Banking API","version":"1.0.1"},"components":{"schemas":{"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"string"},"message":{"type":"string"}}}}}}
```

## The Кошельки object

```json
{"openapi":"3.1.0","info":{"title":"PlazaWorld Banking API","version":"1.0.1"},"components":{"schemas":{"Кошельки":{"type":"object","properties":{"wallet_id":{"type":"string","format":"uuid"},"owner_id":{"type":"string"},"wallet_type":{"type":"string","enum":["personal","company"]},"bank_id":{"type":"string","format":"uuid"},"label":{"type":"string"},"balance":{"type":"integer","format":"int64"},"currency":{"type":"string","default":"PZW"},"frozen":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"}}}}}}
```

## The CreateWalletRequest object

```json
{"openapi":"3.1.0","info":{"title":"PlazaWorld Banking API","version":"1.0.1"},"components":{"schemas":{"CreateWalletRequest":{"type":"object","required":["owner_id","wallet_type"],"properties":{"owner_id":{"type":"string","description":"Идентификатор владельца (игрок/компания)"},"wallet_type":{"type":"string","enum":["personal","company"]},"label":{"type":"string"},"currency":{"type":"string","default":"PZW"}}}}}}
```

## The Переводы object

```json
{"openapi":"3.1.0","info":{"title":"PlazaWorld Banking API","version":"1.0.1"},"components":{"schemas":{"Переводы":{"type":"object","properties":{"tx_id":{"type":"string","format":"uuid"},"from_wallet":{"type":"string","format":"uuid"},"to_wallet":{"type":"string","format":"uuid"},"amount":{"type":"integer","format":"int64"},"fee":{"type":"integer","format":"int64"},"status":{"type":"string","enum":["ok"]},"initiated_by":{"type":"string","format":"uuid"},"idempotency_key":{"type":"string"},"description":{"type":"string"},"created_at":{"type":"string","format":"date-time"}}}}}}
```

## The TransferRequest object

```json
{"openapi":"3.1.0","info":{"title":"PlazaWorld Banking API","version":"1.0.1"},"components":{"schemas":{"TransferRequest":{"type":"object","required":["from_wallet","to_wallet","amount","idempotency_key"],"properties":{"from_wallet":{"type":"string","format":"uuid"},"to_wallet":{"type":"string","format":"uuid"},"amount":{"type":"integer","format":"int64","minimum":1},"currency":{"type":"string"},"description":{"type":"string"},"idempotency_key":{"type":"string","description":"Уникальный ключ для идемпотентности"}}}}}}
```

## The BatchTransferRequest object

```json
{"openapi":"3.1.0","info":{"title":"PlazaWorld Banking API","version":"1.0.1"},"components":{"schemas":{"BatchTransferRequest":{"type":"object","required":["from_wallet","transfers","idempotency_key"],"properties":{"from_wallet":{"type":"string","format":"uuid"},"transfers":{"type":"array","minItems":1,"items":{"type":"object","required":["to_wallet","amount"],"properties":{"to_wallet":{"type":"string","format":"uuid"},"amount":{"type":"integer","format":"int64","minimum":1},"description":{"type":"string"}}}},"idempotency_key":{"type":"string"}}}}}}
```

## The BatchResult object

```json
{"openapi":"3.1.0","info":{"title":"PlazaWorld Banking API","version":"1.0.1"},"components":{"schemas":{"BatchResult":{"type":"object","properties":{"batch_id":{"type":"string"},"status":{"type":"string"},"total_amount":{"type":"integer","format":"int64"},"total_fee":{"type":"integer","format":"int64"},"transfers":{"type":"array","items":{"type":"object","properties":{"tx_id":{"type":"string","format":"uuid"},"to_wallet":{"type":"string","format":"uuid"},"status":{"type":"string"}}}}}}}}}
```

## The История транзакций object

```json
{"openapi":"3.1.0","info":{"title":"PlazaWorld Banking API","version":"1.0.1"},"components":{"schemas":{"История транзакций":{"type":"object","properties":{"tx_id":{"type":"string","format":"uuid"},"from_wallet":{"type":"string","format":"uuid"},"to_wallet":{"type":"string","format":"uuid"},"amount":{"type":"integer","format":"int64"},"fee":{"type":"integer","format":"int64"},"status":{"type":"string"},"initiated_by":{"type":"string","format":"uuid"},"idempotency_key":{"type":"string"},"description":{"type":"string"},"created_at":{"type":"string","format":"date-time"}}}}}}
```

## The Вебхук-события object

```json
{"openapi":"3.1.0","info":{"title":"PlazaWorld Banking API","version":"1.0.1"},"components":{"schemas":{"Вебхук-события":{"type":"object","properties":{"event":{"type":"string","description":"Тип события (transaction.completed, wallet.frozen, bank.suspended)"},"payload":{"type":"string","description":"JSON-строка с данными события"},"created_at":{"type":"string","format":"date-time"}}}}}}
```

## The Обменный курс object

```json
{"openapi":"3.1.0","info":{"title":"PlazaWorld Banking API","version":"1.0.1"},"components":{"schemas":{"Обменный курс":{"type":"object","properties":{"currency":{"type":"string"},"rate_to_usd":{"type":"number","format":"double"},"updated_at":{"type":"string","format":"date-time"}}}}}}
```

## The Настройки банка object

```json
{"openapi":"3.1.0","info":{"title":"PlazaWorld Banking API","version":"1.0.1"},"components":{"schemas":{"Настройки банка":{"type":"object","properties":{"webhook_url":{"type":"string","format":"uri","description":"URL для получения вебхук-уведомлений"},"fee_rate":{"type":"number","format":"double","minimum":0,"maximum":0.05,"description":"Комиссия банка (0 или 0.05)"}}}}}}
```

## The WebhookPayload object

```json
{"openapi":"3.1.0","info":{"title":"PlazaWorld Banking API","version":"1.0.1"},"components":{"schemas":{"WebhookPayload":{"type":"object","description":"Тело вебхук-уведомления, отправляемого на webhook_url банка","properties":{"event":{"type":"string","enum":["transaction.completed","wallet.frozen","bank.suspended"]},"tx_id":{"type":"string","format":"uuid"},"direction":{"type":"string","enum":["incoming","outgoing"]},"wallet_id":{"type":"string","format":"uuid"},"amount":{"type":"integer","format":"int64"},"fee":{"type":"integer","format":"int64"},"balance_after":{"type":"integer","format":"int64"},"counterparty_wallet":{"type":"string","format":"uuid"},"description":{"type":"string"},"created_at":{"type":"string","format":"date-time"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.plazaworld.pw/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.