xrocket-pay-api-sdk

{ "openapi": "3.0.0", "paths": { "/version": { "get": { "operationId": "VersionController_getVersion", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Version" } } } } }, "summary": "Returns current version of API. You may use it as healthcheck", "tags": [ "version" ] } }, "/multi-cheque": { "post": { "operationId": "ChequesController_createCheque", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChequeDto" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "title": "SimpleChequeResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/Cheque" } } } ] } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "security": [ { "api-key": [] } ], "summary": "Create multi-cheque", "tags": [ "multi-cheque" ] }, "get": { "operationId": "ChequesController_getCheques", "parameters": [ { "name": "limit", "required": false, "in": "query", "schema": { "minimum": 1, "maximum": 1000, "default": 100, "type": "number" } }, { "name": "offset", "required": false, "in": "query", "schema": { "minimum": 0, "default": 0, "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "title": "PaginatedShortChequeDtoResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseDto" }, { "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PaginationDto" }, { "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/ShortChequeDto" } } } } ] } } } ] } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "security": [ { "api-key": [] } ], "summary": "Get list of multi-cheques", "tags": [ "multi-cheque" ] } }, "/multi-cheque/{id}": { "get": { "operationId": "ChequesController_getCheque", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "title": "SimpleChequeResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/Cheque" } } } ] } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "security": [ { "api-key": [] } ], "summary": "Get multi-cheque info", "tags": [ "multi-cheque" ] }, "put": { "operationId": "ChequesController_editCheque", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateChequeDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "title": "SimpleChequeResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/Cheque" } } } ] } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "security": [ { "api-key": [] } ], "summary": "Edit multi-cheque", "tags": [ "multi-cheque" ] }, "delete": { "operationId": "ChequesController_deleteCheque", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponseDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "security": [ { "api-key": [] } ], "summary": "Delete multi-cheque", "tags": [ "multi-cheque" ] } }, "/app/info": { "get": { "operationId": "AppsController_getAppInfo", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "security": [ { "api-key": [] } ], "summary": "Returns information about your application", "tags": [ "app" ] } }, "/app/transfer": { "post": { "operationId": "AppsController_transfer", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTransferDto" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "title": "SimpleTransferDtoResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/TransferDto" } } } ] } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "security": [ { "api-key": [] } ], "summary": "Make transfer of funds to another user", "tags": [ "app" ] } }, "/app/withdrawal": { "post": { "operationId": "AppsController_withdrawal", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppCreateWithdrawalDto" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "title": "SimpleWithdrawalDtoResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/WithdrawalDto" } } } ] } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "security": [ { "api-key": [] } ], "summary": "Make withdrawal of funds to external wallet", "tags": [ "app" ] } }, "/app/withdrawal/status/{withdrawalId}": { "get": { "operationId": "AppsController_getWithdrawalStatus", "parameters": [ { "name": "withdrawalId", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "title": "SimpleWithdrawalDtoResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/WithdrawalDto" } } } ] } } } } }, "security": [ { "api-key": [] } ], "summary": "Returns withdrawal status", "tags": [ "app" ] } }, "/app/withdrawal/fees": { "get": { "operationId": "AppsController_getWithdrawalFees", "parameters": [ { "name": "currency", "required": false, "in": "query", "description": "Coin for get fees, optional", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "title": "MultiWithdrawalCoinResponseDtoResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseMultiDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WithdrawalCoinResponseDto" } } } } ] } } } } }, "security": [ { "api-key": [] } ], "summary": "Returns withdrawal fees", "tags": [ "app" ] } }, "/tg-invoices": { "post": { "callbacks": { "successfulPayment": { "your-webhook-url": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WebhookDto" }, { "properties": { "data": { "$ref": "#/components/schemas/PayInvoiceDto" } } } ] } } } }, "responses": { "200": { "description": "OK" } } } } } }, "operationId": "InvoicesController_createInvoice", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceDto" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "title": "SimpleInvoiceDtoResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/InvoiceDto" } } } ] } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "security": [ { "api-key": [] } ], "summary": "Create invoice", "tags": [ "tg-invoices" ] }, "get": { "operationId": "InvoicesController_getInvoices", "parameters": [ { "name": "limit", "required": false, "in": "query", "schema": { "minimum": 1, "maximum": 1000, "default": 100, "type": "number" } }, { "name": "offset", "required": false, "in": "query", "schema": { "minimum": 0, "default": 0, "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "title": "PaginatedInvoiceDtoResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseDto" }, { "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PaginationDto" }, { "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceDto" } } } } ] } } } ] } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "security": [ { "api-key": [] } ], "summary": "Get list of invoices", "tags": [ "tg-invoices" ] } }, "/tg-invoices/{id}": { "get": { "operationId": "InvoicesController_getInvoice", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "title": "SimpleFullInvoiceDtoResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/FullInvoiceDto" } } } ] } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "security": [ { "api-key": [] } ], "summary": "Get invoice info", "tags": [ "tg-invoices" ] }, "delete": { "operationId": "InvoicesController_deleteInvoice", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponseDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "security": [ { "api-key": [] } ], "summary": "Delete invoice", "tags": [ "tg-invoices" ] } }, "/currencies/available": { "get": { "operationId": "CurrenciesController_getCoins", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailableCoins" } } } } }, "summary": "Returns available currencies", "tags": [ "currencies" ] } }, "/withdrawal-link": { "get": { "description": "\u003Cb\u003EIMPORTANT: Don't use xRocket Pay token on frontend, it can cause funds loss.\u003C/b\u003E\u003Cbr /\u003EFor backend integration, token usage is optional but may be used later for trust verification.", "operationId": "WithdrawalLinkController_getWithdrawalLink", "parameters": [ { "name": "currency", "required": true, "in": "query", "description": "Currency code (get list from GET /currency/available)", "schema": { "example": "USDT", "type": "string" } }, { "name": "network", "required": true, "in": "query", "description": "Network code", "schema": { "default": "TON", "enum": [ "TON", "BSC", "ETH", "BTC", "TRX", "SOL" ], "type": "string" } }, { "name": "address", "required": true, "in": "query", "description": "Target withdrawal address", "schema": { "example": "UQABGo8KCza3ea8DNHMnSWZmbRzW-05332eTdfvW-XDQEmnJ", "type": "string" } }, { "name": "amount", "required": false, "in": "query", "description": "Withdrawal amount", "schema": { "example": "1.23", "type": "string" } }, { "name": "comment", "required": false, "in": "query", "description": "Withdrawal comment", "schema": { "maxLength": 50, "example": "", "type": "string" } }, { "name": "platform", "required": false, "in": "query", "description": "Platform identifier (optional, use only if provided by xRocket)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "title": "SimpleWithdrawalLinkDtoResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/WithdrawalLinkDto" } } } ] } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "summary": "Get withdrawal link", "tags": [ "withdrawal-link" ] } }, "/health": { "get": { "operationId": "HealthController_health", "parameters": [], "responses": { "200": { "description": "Health check", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "info", "error", "details" ], "properties": { "status": { "type": "string", "enum": [ "ok", "error", "shutting_down" ], "example": "ok" }, "info": { "type": "array", "items": { "type": "object", "required": [ "name", "status" ], "properties": { "name": { "type": "string", "example": "component" }, "status": { "type": "string", "enum": [ "up", "down" ], "example": "up" }, "message": { "type": "string", "example": "example message" } } } }, "error": { "type": "array", "items": { "type": "object", "required": [ "name", "status" ], "properties": { "name": { "type": "string", "example": "component" }, "status": { "type": "string", "enum": [ "up", "down" ], "example": "down" }, "message": { "type": "string", "example": "example message" } } } }, "details": { "type": "array", "items": { "type": "object", "required": [ "name", "status" ], "properties": { "name": { "type": "string", "example": "component" }, "status": { "type": "string", "enum": [ "up", "down" ], "example": "up" }, "message": { "type": "string", "example": "example message" } } } } } } } } } }, "tags": [ "health", "health" ] } } }, "info": { "title": "xRocket Pay API", "description": "This API based on @xRocket (@ton_rocket_test_bot for testnest) Payment System. In order to use it, you need to get API key from bot. Open it and go to Rocket Pay \u003E Create App \u003E API token.\u003Cbr\u003E\u003Cbr\u003EThis page is fully interactive. Provide obtained API key to AUTHORIZE button on the right, and you can try all API methods by simply clicking buttons and filling forms here\u003Cbr\u003E\u003Cbr\u003EAPI token must be specified in header of each request. Header name is \u003Cb\u003ERocket-Pay-Key\u003C/b\u003E. Only exception is /version endpoint\u003Cbr\u003E\u003Cbr\u003EIf endpoint can send webhooks in response, it is provided on endpoint page on Callbacks bookmark. Now only /tg-invoices endpoint sends webhooks. You can turn them on in bot in app management page\u003Cbr\u003EIn order to verify webhooks information integrity, we send you in headers parameter \u003Cb\u003Erocket-pay-signature\u003C/b\u003E, which is hex representation of HMAC-SHA-256 signature used to sign request body with a secret key that is SHA256 hash of your app token.\u003Cbr\u003E\u003Cbr\u003EThis specification fully complies with OpenAPI 3.0 standard, so if you want to see schemas of request bodies or responses, please click \"Schema\" inside endpoint. All mandatory fields marked with *, all types and limits also described inside schemas\u003Cbr\u003E\u003Cbr\u003E\u003Ch2\u003EChange Log\u003C/h2\u003E\u003Ch3\u003Eversion 1.3\u003C/h3\u003EAdded support for multi-invoices:\u003Cbr\u003Epost /tg-invoices - added request parameter numPayments (default - 1), added response parameter totalActivations, activationsLeft\u003Cbr\u003Ewebhook /tg-invoices - added parameter payment (telegram user ID and number of items purchased for this payment)\u003Cbr\u003Eget /tg-invoices - added response parameter totalActivations, activationsLeft\u003Cbr\u003Eget /tg-invoices/{id} - added response parameter numPayments and payments (list, info about payments that were maid for this invoice)\u003Cbr\u003E\u003Ch3\u003Eversion 1.3.1\u003C/h3\u003EAdded support for multi-invoices with any amount and any payments number (you can put 0 to amount and numPayments)\u003Cbr\u003Eget /tg-invoices/{id} - added to response payments object parameters: paid and payment amount\u003Cbr\u003Ewebhook /tg-invoices - added to payment object parameters: paid and payment amount\u003Cbr\u003E", "version": "1.3.1", "contact": { } }, "tags": [ { "name": "version", "description": "" }, { "name": "app", "description": "" }, { "name": "multi-cheque", "description": "Here you can save multi-cheque. Referral program also could be set. No additional fees taken." }, { "name": "tg-invoices", "description": "Here you can save one-time invoices that can be payed via xRocket bot and get link for these invoices.\u003Cbr\u003E This endpoint sends updates to your webhook if it is enabled. You can find webhook model on Callbacks bookmark below\u003Cbr\u003EIf you want to save invoices that can be payed only via attached address (no telegram access required), we will support it soon too" }, { "name": "withdrawal-link", "description": "Here you can generate deeplinks for withdrawals for simplified integration. User will confirm withdrawal after following link.\u003Cbr\u003EPerfect for services that already accept crypto payments and need to offer easy top-up via xRocket." } ], "servers": [ { "url": "https://pay.xrocket.tg/", "description": "Prod" } ], "components": { "securitySchemes": { "api-key": { "type": "apiKey", "in": "header", "name": "Rocket-Pay-Key" } }, "schemas": { "Version": { "type": "object", "properties": { "version": { "type": "string", "example": 0.1 } }, "required": [ "version" ] }, "PropertyError": { "type": "object", "properties": { "property": { "type": "string", "description": "name of input field that cannot be processed", "example": "somePropertyName" }, "error": { "type": "string", "example": "somePropertyName should be less than X", "description": "text explaining what exactly wrong" } }, "required": [ "property", "error" ] }, "ApiBadRequestError": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Error Message" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyError" } } }, "required": [ "success", "message" ] }, "ApiError": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Error Message" } }, "required": [ "success", "message" ] }, "PaginationDto": { "type": "object", "properties": { "total": { "type": "number", "description": "Total times" }, "limit": { "type": "number", "maximum": 1000, "minimum": 1, "example": 100, "default": 100 }, "offset": { "type": "number", "minimum": 0, "default": 100 } }, "required": [ "total", "limit", "offset" ] }, "ShortChequeDto": { "type": "object", "properties": { "id": { "type": "number", "description": "Cheque ID", "example": 10 }, "currency": { "type": "string", "example": "TONCOIN" }, "total": { "type": "number", "description": "Total amount of cheque (this amount is charged from balance)", "example": 10 }, "perUser": { "type": "number", "description": "Amount of cheque per user", "example": 10 }, "users": { "type": "number", "description": "Number of users that can activate your cheque", "example": 10 }, "password": { "type": "object", "description": "Cheque password", "example": "pwd" }, "description": { "type": "object", "description": "Cheque description", "example": "this cheque is the best" }, "sendNotifications": { "type": "boolean", "description": "send notifications about cheque activation to application cheque webhook or not" }, "captchaEnabled": { "type": "boolean", "description": "ena