{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c1a52d22-d8f9-4a57-b955-4979eaec29fe","name":"Lizex Partner API documentation","description":"Partner-facing collection for integrating with the **Lizex** platform. Covers the full exchange lifecycle: fetching available coins, calculating rates, creating exchanges, and monitoring statuses.\n\n- **Base URL:** `https://api.lizex.io`\n    \n- **Auth:** Bearer JWT — passed via the `Authorization: Bearer {{bearerToken}}` header\n    \n- **Response format:** JSON (exception: `coin integration xml retrieve` returns XML)\n    \n\n---\n\n## Authentication\n\nAll endpoints (except `coin integration xml retrieve`) require a partner JWT token.\n\n```\nAuthorization: Bearer {{bearerToken}}\n\n ```\n\nConfigure the following environment variables in Postman:\n\n| Variable | Description | Example |\n| --- | --- | --- |\n| `baseUrl` | Base URL of the API | `https://api.lizex.io` |\n| `bearerToken` | Partner account Bearer token | `eyJhbGci...` |\n\n---\n\n## Collection Structure\n\nThe collection is organized into two folders: **coin** and **exchange**.\n\n---\n\n## coin\n\n### GET coin list\n\n`GET /coin/integration/coins/`\n\nReturns a paginated list of all coins available for exchange, including their supported networks.\n\n**Query parameters:**\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `page` | integer | Page number |\n| `page_size` | integer | Number of results per page |\n| `search` | string | Search by ticker or name |\n\n**success response** **`200`****:** Paginated list of `Coin` objects:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `count` | integer | Total number of coins |\n| `next` | string / null | URL of the next page |\n| `previous` | string / null | URL of the previous page |\n| `results` | array | List of coin objects |\n\nEach coin object:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `token` | string | Coin ticker (e.g. `TRX`, `ETH`) |\n| `title` | string | Full coin name (e.g. `Tron`, `Ethereum`) |\n| `is_memo` | boolean | Whether this coin requires a memo / tag field |\n| `networks` | array | List of supported networks, each with a `title` field |\n\n---\n\n### GET coin integration xml retrieve\n\n`GET /coin/integration/xml/`\n\nReturns an XML feed with coin and rate data. Authentication is optional for this endpoint.\n\n**XML response** **`200`****:** XML document (not JSON).\n\n---\n\n## exchange\n\n### POST exchange calculate\n\n`POST /exchange/integration/exchange/v2/calculate/`\n\nCalculates the exchange result for a given pair and amount. Call this before creating an exchange to preview the rate, result amount, and allowed range.\n\n**Request body (JSON):**\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `from_coin` | string | Yes | Source coin ticker (e.g. `TRX`) |\n| `from_chain` | string | Yes | Source network (e.g. `TRC20`) |\n| `to_coin` | string | Yes | Destination coin ticker (e.g. `ETH`) |\n| `to_chain` | string | Yes | Destination network (e.g. `ERC20`) |\n| `amount` | decimal | Yes | Amount to calculate (up to 12 integer digits, up to 18 decimal digits) |\n| `side` | enum | No | Calculation direction. Default: `from` |\n| `commission_type` | enum | No | Commission type. Default: `float` |\n\n**`side`** **enum:**\n\n| Value | Description |\n| --- | --- |\n| `from` | `amount` is what the client sends; `result` is what the client receives |\n| `to` | `amount` is what the client wants to receive; `result` is what the client needs to send |\n\n**`commission_type`** **enum:**\n\n| Value | Description |\n| --- | --- |\n| `float` | Rate is not fixed upfront; it is determined during the exchange process |\n| `fix` | Rate is locked at the time of exchange creation (fixed rate) |\n\n**success response** **`200`****:**\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `result` | decimal | Calculated receive or send amount |\n| `rate` | decimal | Effective exchange rate |\n| `min_amount` | decimal | Minimum allowed amount |\n| `max_amount` | decimal | Maximum allowed amount |\n\n**amounts error** **`400`****:** Amount is outside the allowed range:\n\n| Field | Description |\n| --- | --- |\n| `amount` | The submitted amount |\n| `min_amount` | Minimum allowed amount |\n| `max_amount` | Maximum allowed amount |\n\n**validation errors** **`404`****:** Validation error on the pair or amount:\n\n| Field | Example value |\n| --- | --- |\n| `amount` | `Amount must be greater than zero` |\n| `pairs` | `From and To pairs must be different` |\n\n---\n\n### POST exchange create\n\n`POST /exchange/integration/exchange/v2/create/`\n\nCreates a new exchange. It is recommended to call `exchange calculate` first to verify parameters and confirm the rate is acceptable before proceeding.\n\n**Request body (JSON):**\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `from_coin` | string | Yes | Source coin ticker (e.g. `TRX`) |\n| `from_chain` | string | Yes | Source network (e.g. `TRC20`) |\n| `to_coin` | string | Yes | Destination coin ticker |\n| `to_chain` | string | Yes | Destination network |\n| `amount` | decimal | Yes | Exchange amount |\n| `address` | string | Yes | Destination address (where the exchanged funds will be sent) |\n| `memo` | string | Yes | Memo / tag for the destination address (pass an empty string if not required) |\n| `side` | enum | No | `from` / `to`. Default: `from` |\n| `commission_type` | enum | No | `float` / `fix`. Default: `float` |\n| `support_email` | email | No | Contact email associated with this exchange |\n| `withdraw_refund` | string | No | Address for refund in case of problems |\n\n**success creation** **`200`****:** Returns a full `ExchangeDetailPartner` object for the created exchange.\n\nThe `deposit.address` field contains the address where the client must send the source funds to proceed with the exchange.\n\nFor full field reference see `exchange integration retrieve` below.\n\n**amounts error** **`400`****:** Same structure as `exchange calculate`.\n\n**validation errors** **`404`****:** Same structure as `exchange calculate`.\n\n---\n\n### GET exchange integration list\n\n`GET /exchange/integration/exchange/v2/`\n\nReturns a paginated list of all exchanges created under the authenticated partner account.\n\n**Query parameters:**\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `page` | integer | Page number |\n| `page_size` | integer | Number of results per page |\n| `search` | string | Search term |\n\n**success response** **`200`****:** Paginated list of `ExchangeDetailPartner` objects. See field reference below.\n\n---\n\n### GET exchange integration retrieve\n\n`GET /exchange/integration/exchange/v2/{unique_id}/`\n\nReturns the full details of a single exchange by its unique identifier.\n\n**Path parameters:**\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `unique_id` | string | Exchange unique ID (max 13 characters) |\n\n**success response** **`200`****:** `ExchangeDetailPartner` object:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `unique_id` | string | Exchange identifier |\n| `rate_type` | enum | Rate type applied to this exchange (see below) |\n| `status` | enum | Current exchange status (see below) |\n| `start_time` | datetime | Exchange creation time |\n| `end_time` | datetime / null | Completion time |\n| `expire_time` | datetime | Time after which the exchange expires if no deposit is received |\n| `deposit` | object | Incoming side — details of what the client sends |\n| `withdrawal` | object | Outgoing side — details of what the client receives |\n| `support_email` | email | Support email for this exchange |\n| `withdraw_refund` | string | Refund address |\n| `partner_profit` | number / null | Partner profit amount, denominated in USDT |\n\n**`rate_type`** **enum:**\n\n| Value | Description |\n| --- | --- |\n| `float` | Rate was not fixed upfront; it was determined during the exchange process |\n| `fix` | Rate was fixed when the exchange was created |\n\n**`status`** **enum:**\n\n| Code | Value | Description |\n| --- | --- | --- |\n| `1` | `waiting` | Waiting for the client's deposit |\n| `2` | `confirmation` | Deposit received, awaiting blockchain confirmations |\n| `3` | `transferring` | Funds are being transferred internally |\n| `4` | `exchanging` | Exchange operation is in progress |\n| `5` | `sending` | Sending funds to the destination address |\n| `6` | `success` | Exchange completed successfully |\n| `7` | `overdue` | Deposit was not received before expiration |\n| `8` | `frozen` | Exchange is frozen pending review |\n| `9` | `problematic` | Requires manual processing |\n| `10` | `refunded` | Funds have been returned to the sender |\n\n**`deposit`** **object fields (incoming side):**\n\n| Field | Description |\n| --- | --- |\n| `address` | Address the client must send funds to |\n| `memo` | Memo / tag for the address (empty string if not required) |\n| `coin` | Coin ticker (e.g. `TRX`) |\n| `coin_repr` | Full coin name with network (e.g. `Tron`) |\n| `chain` | Network name (e.g. `TRC20`) |\n| `amount` | Expected deposit amount |\n| `txid` | Incoming transaction hash (null until received) |\n| `start_time` | Operation start time |\n| `actual` | Current number of blockchain confirmations |\n| `required` | Number of confirmations required to proceed |\n\n**`withdrawal`** **object fields (outgoing side):**\n\n| Field | Description |\n| --- | --- |\n| `address` | Destination address |\n| `memo` | Memo / tag (empty string if not required) |\n| `coin` | Coin ticker |\n| `coin_repr` | Full coin name with network |\n| `chain` | Network name |\n| `amount` | Amount to be sent |\n| `txid` | Outgoing transaction hash (null until sent) |\n| `start_time` | Operation start time |\n\n---\n\n## Typical integration flow\n\n```\n1. GET  coin list\n        -> Fetch available coins and their supported networks\n2. POST exchange calculate\n        -> Calculate the rate and result amount for the selected pair\n3. POST exchange create\n        -> Create the exchange\n        <- Response contains deposit.address — the address the client must send funds to\n4. GET  exchange integration retrieve\n        -> Poll to monitor status changes\n        <- status progresses: 1 (waiting) -> 2 -> 3 -> 4 -> 5 -> 6 (success)\n\n ```\n\n---\n\n## HTTP status codes\n\n| Code | Meaning |\n| --- | --- |\n| `200` | Successful response |\n| `400` | Bad request — amount is outside the allowed range |\n| `401` | Unauthorized — missing or invalid token |\n| `404` | Pair validation error or resource not found |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"51166054","team":8936203,"collectionId":"c1a52d22-d8f9-4a57-b955-4979eaec29fe","publishedId":"2sBXVeEsDa","public":true,"publicUrl":"https://docs.lizex.io","privateUrl":"https://go.postman.co/documentation/51166054-c1a52d22-d8f9-4a57-b955-4979eaec29fe","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3460fd"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Lizex API documentation for partners to build integration flow"},{"name":"title","value":"Lizex API Documentation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"3460fd"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3460fd"}}]}},"version":"8.10.1","publishDate":"2026-01-07T14:40:32.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Lizex API Documentation","description":"Lizex API documentation for partners to build integration flow"},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Production","id":"10471d75-9e54-4e99-b60f-225c232a58fd","owner":"46909352","values":[{"key":"baseUrl","value":"https://api.lizex.io","enabled":true,"type":"default"},{"key":"bearerToken","value":"<your token>","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/1176a8a7e4ad4af29960faf14eb84871ac3a8fb09fe9ca40ce84bc8a62727c22","favicon":"https://res.cloudinary.com/postman/image/upload/v1767795697/team/42c7d25bf391c20348b5f00e3a49df3a.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Production","value":"46909352-10471d75-9e54-4e99-b60f-225c232a58fd"}],"canonicalUrl":"https://docs.lizex.io/view/metadata/2sBXVeEsDa"}