{"info":{"_postman_id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","name":"Kyrrex Malta on/off-ramp","description":"

Introduction

Welcome to the API Documentation for our financial services platform. This document provides comprehensive details on how to interact with our API to perform a wide range of operations, including managing fiat and crypto withdrawals, retrieving requisites, handling exchanges, and more.

Overview

Our API is designed to provide secure, efficient, and easy-to-use access to our platform's capabilities. It supports various operations crucial for integrating financial services into your applications. This includes endpoints for creating and managing withdrawals, listing and filtering requisites, handling currency exchanges, and estimating exchange rates.

Request Format

Requests to our API should be made using standard HTTP methods, such as GET, POST, and DELETE. Each endpoint details the required method, parameters, and possible responses.

Response Format

Our API responses are formatted in JSON, providing a clear and consistent structure for handling data. Each endpoint's documentation includes examples of successful responses and potential error messages.

On-Ramp Process Description:

\n\n

Off-Ramp Process Description:

\n\n

Error Handling

In case of errors, the API will return appropriate HTTP status codes along with a message describing the error. Common error codes include:

400 Bad Request: The request was invalid or cannot be served.
\n
401 Unauthorized: Authentication failed or user does not have permissions for the desired action.
\n
404 Not Found: The requested resource could not be found.
\n
500 Internal Server Error: An error occurred on the server.
\n

Pre-Script

const secretKey = pm.collectionVariables.get(\"secret_key\");\nconst method = pm.request.method;\nconst endpoint = pm.request.url.getPath();\nlet dataToSign;\nfunction objectToQueryString(obj) {\n    const flatObject = flattenObject(obj);\n    const sortedKeys = Object.keys(flatObject).sort();\n    const queryParams = sortedKeys.map(key => `${key}=${flatObject[key]}`);\n    return queryParams.join('&');\n}\nfunction flattenObject(obj, parentKey = '', res = {}) {\n    for (let key in obj) {\n        const propName = parentKey ? parentKey + '_' + key : key;\n        if (typeof obj[key] === 'object' && obj[key] !== null && !Array.isArray(obj[key]))\n            flattenObject(obj[key], propName, res);\n        else\n            res[propName] = obj[key];\n    }\n    return res;\n}\nif (method === \"GET\") {\n    const queryParams = pm.request.url.query.all();\n    queryParams.sort((a, b) => a.key.localeCompare(b.key));\n    dataToSign = queryParams.map(param => `${param.key}=${param.value}`).join('&');\n} else if ([\"POST\", \"PUT\", \"PATCH\", \"DELETE\"].includes(method)) {\n    const requestBody = JSON.parse(pm.request.body.raw || '{}');\n    dataToSign = objectToQueryString(requestBody);\n}\nconst message = `${method}|${endpoint}|${dataToSign}`;\nconst signature = CryptoJS.HmacSHA256(message, secretKey).toString(CryptoJS.enc.Hex);\npm.collectionVariables.set(\"signature\", signature);\nconsole.log([\"script_message\", message]);\n\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"42711896","collectionId":"1ec0a151-cb85-4368-bde8-c7c30893a6da","publishedId":"2sB2j69W1G","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-05-07T10:32:16.000Z"},"item":[{"name":"members","item":[{"name":"me","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"7bb31243-4274-43a5-aef3-9805c39cf9e3"}}],"id":"214a47e4-f7c6-4b5a-acba-848314a22a8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"APIKey","value":"","type":"text"},{"key":"APISign","value":"","type":"text"},{"key":"Auth-Token","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb","type":"text"}],"url":"https://my.kyrrex.mt/api/v1/business/members/me","description":"

Request

This endpoint makes an HTTP GET request to retrieve the details of the currently authenticated member. The request does not require any request body parameters.

Response

Upon a successful request, the endpoint returns a JSON object with the following fields:

activated (boolean): Indicates whether the member's account is activated.
\n
average_holding (string): Represents the average holding of the member.
\n
banned (boolean): Indicates whether the member's account is banned.
\n
email (string): The email address associated with the member's account.
\n
fee_grid_id (integer): The ID associated with the fee grid.
\n
fee_grid_note (object): An object containing details about the fee grid, including its ID, market ID, name, stacking, volume, fee taker, fee maker, fee fiat system, fee fiat exchange, fee fiat provider, creation date, and update date.
\n
trading_volume (string): Represents the trading volume of the member.
\n
uid (string): The unique identifier for the member's account.
\n
verified (boolean): Indicates whether the member's account is verified.
\n

Example

{\n    \"activated\": true,\n    \"average_holding\": \"\",\n    \"banned\": true,\n    \"email\": \"\",\n    \"fee_grid_id\": 0,\n    \"fee_grid_note\": {\n        \"id\": 0,\n        \"market_id\": \"\",\n        \"name\": \"\",\n        \"stacking\": \"\",\n        \"volume\": \"\",\n        \"fee_taker\": \"\",\n        \"fee_maker\": \"\",\n        \"fee_fiat_system\": \"\",\n        \"fee_fiat_exchange\": \"\",\n        \"fee_fiat_provider\": \"\",\n        \"created_at\": \"\",\n        \"updated_at\": \"\"\n    },\n    \"trading_volume\": \"\",\n    \"uid\": \"\",\n    \"verified\": true\n}\n\n

Get Total Balance

This endpoint retrieves the total balance of the members for a specific output asset.

Request

Method: GET
\n
URL: https://my.kyrrex.mt/api/v1/business/members/total_balance
\n
Query Parameters:
\n
- output_asset (string, required): The output asset for which the total balance is requested.
\n

Response

output_asset (string): The requested output asset.
\n
total (string): The total balance.
\n
accounts (object): The balances for different assets including crypto and fiat.
\n
- btc, ltc, eur, eth, xlm, usdc, xrp, bch, trx, usdt (string): Balances for different crypto assets.
\n
crypto (object): Total and individual crypto asset balances.
\n
- total (string): Total crypto asset balance.
  \n
- accounts (object): Balances for different crypto assets.
  \n
  - btc, ltc, eth, xlm, usdc, xrp, bch, trx, usdt (string): Balances for different crypto assets.
  \n
\n
fiat (object): Total and individual fiat asset balances.
\n
- total (string): Total fiat asset balance.
  \n
- accounts (object): Balances for different fiat assets.
  \n
  - eur (string): Balance for Euro.
  \n
\n
udr (object): Total and individual UDR (User Defined Rights) asset balances.
\n
- total (string): Total UDR balance.
  \n
- accounts (object): Balances for different UDR assets.
  \n
\n

This endpoint retrieves a list of member accounts with optional pagination and sorting. The 'sort' parameter allows you to specify the order in which the results are returned, with the options 'asc' for ascending order and 'desc' for descending order.

For example:

To retrieve accounts sorted in ascending order based on a specific criteria, set the 'sort' parameter to 'asc'.
\n
To retrieve accounts sorted in descending order based on a specific criteria, set the 'sort' parameter to 'desc'.
\n
page (optional): The page number for paginating the results.
\n
per_page (optional): The number of items to be included per page.
\n
sort (optional): The sorting order for the results.
\n
sort_by (optional): The parameter to specify the field for sorting, with the value 'currency\\created_at'.
\n

The response will include the total count of accounts, pagination details, and an array of account items. Each account item contains various details such as balance, bonus, coin type, asset, and more. The 'accounts' object further categorizes the accounts into 'crypto', 'fiat', and 'udr' types.

Example response:

{\n    \"total_count\": 0,\n    \"per_page\": 0,\n    \"total_pages\": 0,\n    \"page\": 0,\n    \"prev_page\": null,\n    \"next_page\": null,\n    \"items\": [\n        {\n            \"aml_locked\": \"\",\n            \"balance\": \"\",\n            \"bonus\": \"\",\n            \"coin_type\": \"\",\n            \"asset\": \"\",\n            \"launchpad\": \"\",\n            \"locked\": \"\",\n            \"name\": \"\",\n            \"savings\": \"\",\n            \"stacking\": \"\",\n            \"tag\": \"\",\n            \"total\": \"\"\n        }\n    ],\n    \"accounts\": {\n        \"crypto\": [\n            {\n                \"aml_locked\": \"\",\n                \"balance\": \"\",\n                \"bonus\": \"\",\n                \"coin_type\": \"\",\n                \"asset\": \"\",\n                \"launchpad\": \"\",\n                \"locked\": \"\",\n                \"name\": \"\",\n                \"savings\": \"\",\n                \"stacking\": \"\",\n                \"tag\": \"\",\n                \"total\": \"\"\n            }\n        ],\n        \"fiat\": [\n            {\n                \"aml_locked\": \"\",\n                \"balance\": \"\",\n                \"bonus\": \"\",\n                \"coin_type\": \"\",\n                \"asset\": \"\",\n                \"launchpad\": \"\",\n                \"locked\": \"\",\n                \"name\": \"\",\n                \"savings\": \"\",\n                \"stacking\": \"\",\n                \"tag\": \"\",\n                \"total\": \"\"\n            }\n        ],\n        \"udr\": []\n    }\n}\n\n

page: (optional) Specifies the page number for paginated results.
\n
per_page: (optional) Specifies the number of items to be included per page.
\n
sort: (optional) Specifies the sorting order for the results.
\n
sort_by: (optional) Specifies the attribute by which the results should be sorted.
\n

The response includes the total count of accounts, the number of items per page, total pages, and the current page. Additionally, it provides details of the member accounts including their balance, bonus, coin type, asset, launchpad, locked status, name, savings, stacking, and total value. The accounts are categorized into crypto, fiat, and udr (unidentified) types.

This endpoint retrieves a list of member accounts with optional pagination and sorting parameters.

Request

page (optional, integer): The page number for paginated results.
\n
per_page (optional, integer): The number of items to be included per page.
\n
sort (optional, string): The sorting order for the results.
\n
sort_by (optional, string): The field to be used for sorting.
\n

Response
The response includes the following fields:

total_count (integer): The total count of accounts.
\n
per_page (integer): The number of items per page.
\n
total_pages (integer): The total number of pages.
\n
page (integer): The current page number.
\n
prev_page (nullable, integer): The previous page number, if available.
\n
next_page (nullable, integer): The next page number, if available.
\n
items (array): An array of account objects with the following fields:
\n
- aml_locked (string): AML locked status.
  \n
- balance (string): Account balance.
  \n
- bonus (string): Bonus amount.
  \n
- coin_type (string): Type of cryptocurrency.
  \n
- asset (string): Asset type.
  \n
- launchpad (string): Launchpad status.
  \n
- locked (string): Locked status.
  \n
- name (string): Account holder's name.
  \n
- savings (string): Savings amount.
  \n
- stacking (string): Stacking status.
  \n
- tag (string): Account tag.
  \n
- total (string): Total amount.
  \n
\n

The accounts object includes the following sub-objects:

crypto (array): An array of cryptocurrency accounts with similar fields as items.
\n
fiat (array): An array of fiat accounts with similar fields as items.
\n
udr (array): An array of UDR accounts.
\n

asc\\desc

\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"

currency\\created_at

\n","type":"text/plain"},"key":"sort_by","value":null}],"variable":[]}},"response":[{"id":"2d5418fc-ea9e-4d55-9480-1d4271ea71aa","name":"accounts","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"APIKey","value":"","type":"text"},{"key":"APISign","value":"","type":"text"},{"key":"Auth-Token","value":"396a853becbb69c75234e775dac0cba69ef51bfb","type":"text"}],"url":"https://my.kyrrex.mt/api/v1/business/members/accounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 14 Mar 2025 13:33:11 GMT"},{"key":"X-Ratelimit-Remaining","value":"29999"},{"key":"X-Ratelimit-Reset","value":"60"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Ratelimit-Limit","value":"30000"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"fc0-p+6PmRawLME0e8oR+6aQd3fm5T8\""},{"key":"Vary","value":"accept-encoding"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 ca339b9e98820e424be1609317fd0314.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"FRA56-P7"},{"key":"X-Amz-Cf-Id","value":"3lQVBHSKameOkqSbZF8Dx69uvMab-szmj63soYn4LnIGD4QTXUcHeA=="}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 10,\n \"per_page\": 100,\n \"total_pages\": 1,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": null,\n \"items\": [\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"asset\": \"usdt\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"usdt\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": \"\",\n \"total\": \"0.0\"\n },\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"asset\": \"trx\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"Tron\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": \"\",\n \"total\": \"0.0\"\n },\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"asset\": \"bch\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"Bitcoin Cash\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": \"\",\n \"total\": \"0.0\"\n },\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"asset\": \"xrp\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"xrp\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": \"\",\n \"total\": \"0.0\"\n },\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"asset\": \"usdc\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"USD COIN ERC20\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": \"\",\n \"total\": \"0.0\"\n },\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"asset\": \"xlm\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"xlm\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": null,\n \"total\": \"0.0\"\n },\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"asset\": \"eth\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"eth\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": null,\n \"total\": \"0.0\"\n },\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"fiat\",\n \"asset\": \"eur\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"eur\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": \"\",\n \"total\": \"0.0\"\n },\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"asset\": \"ltc\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"ltc\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": null,\n \"total\": \"0.0\"\n },\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"asset\": \"btc\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"Bitcoin\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": null,\n \"total\": \"0.0\"\n }\n ],\n \"accounts\": {\n \"crypto\": [\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"asset\": \"usdt\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"usdt\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": \"\",\n \"total\": \"0.0\"\n },\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"asset\": \"trx\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"Tron\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": \"\",\n \"total\": \"0.0\"\n },\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"asset\": \"bch\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"Bitcoin Cash\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": \"\",\n \"total\": \"0.0\"\n },\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"asset\": \"xrp\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"xrp\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": \"\",\n \"total\": \"0.0\"\n },\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"asset\": \"usdc\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"USD COIN ERC20\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": \"\",\n \"total\": \"0.0\"\n },\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"asset\": \"xlm\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"xlm\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": null,\n \"total\": \"0.0\"\n },\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"asset\": \"eth\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"eth\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": null,\n \"total\": \"0.0\"\n },\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"asset\": \"ltc\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"ltc\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": null,\n \"total\": \"0.0\"\n },\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"asset\": \"btc\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"Bitcoin\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": null,\n \"total\": \"0.0\"\n }\n ],\n \"fiat\": [\n {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"fiat\",\n \"asset\": \"eur\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"eur\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": \"\",\n \"total\": \"0.0\"\n }\n ],\n \"udr\": []\n }\n}"}],"_postman_id":"9ecdee38-2240-44df-bf54-068ef011b1cf"},{"name":"sign-up","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"bd866d4c-c129-41e8-9968-f394f9c15616"}},{"listen":"test","script":{"exec":["","var responseJson = pm.response.json();","","","if (responseJson.access_key && responseJson.secret_key) {"," pm.collectionVariables.set(\"master_access_key\", responseJson.access_key);"," pm.collectionVariables.set(\"master_secret_key\", responseJson.secret_key);"," "," console.log(\"master_access_key:\", responseJson.access_key);"," console.log(\"master_secret_key:\", responseJson.secret_key);","}"],"type":"text/javascript","packages":{},"id":"315d20d7-c2bf-4571-afe7-7b13950dcc08"}}],"id":"6b7aba8c-5f65-4936-907e-8eee39a88bea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Auth-Token","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"documentation_bapi@test.com\",\n \"type\": \"personal\",\n \"country_id\": 972\n}","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.mt/api/v1/business/members/sign-up","description":"

Request

This endpoint allows users to sign up as members by sending an HTTP POST request to https://my.kyrrex.mt/api/v1/business/members/sign-up. The request should include the following parameters in the raw request body:

{\n  \"email\": \"documentation_bapi@test.com\",\n  \"type\": \"personal\",\n  \"country_id\": 972\n}\n\n

Response

Upon making a successful request, a JSON response is returned with the following information:

access_key (string): The access key for the user.
\n
activated (boolean): Indicates the activation status.
\n
banned (boolean): Indicates whether the user is banned.
\n
email (string): The email address of the user.
\n
secret_key (string): The secret key associated with the user.
\n
uid (string): The UUID (unique identifier) for the user.
\n
verified (boolean): Indicates the verification status of the user.
\n

The response schema can be documented as follows:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"access_key\": {\"type\": \"string\"},\n    \"activated\": {\"type\": \"boolean\"},\n    \"banned\": {\"type\": \"boolean\"},\n    \"email\": {\"type\": \"string\"},\n    \"secret_key\": {\"type\": \"string\"},\n    \"uid\": {\"type\": \"string\"},\n    \"verified\": {\"type\": \"boolean\"}\n  }\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","name":"Kyrrex Malta on/off-ramp","type":"collection"}},"urlObject":{"path":["api","v1","business","members","sign-up"],"host":["https://my.kyrrex.mt"],"query":[],"variable":[]}},"response":[{"id":"763415d3-b3cb-4e4a-85e8-a275a237b4bc","name":"200","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Auth-Token","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"documentation_bapi@test.com\",\n \"type\": \"personal\",\n \"country_id\": 972\n}","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.mt/api/v1/business/members/sign-up"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"219"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 14 Mar 2025 13:30:18 GMT"},{"key":"X-Ratelimit-Reset","value":"20"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Etag","value":"W/\"db-1pKfVp8C5ZhnQ/S5QyO7J54j70w\""},{"key":"X-Ratelimit-Limit","value":"30000"},{"key":"X-Ratelimit-Remaining","value":"29998"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 1b575b46b9e4dd6b829accb4ea728b00.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"AMS1-P2"},{"key":"X-Amz-Cf-Id","value":"lyyXxhhYsMMmrDkbklhgeXZg9DrJ9cPgYnjnbiWXXVa-isCiU6GoJw=="}],"cookie":[],"responseTime":null,"body":"{\n \"access_key\": \"UTRk5d8JXSkCUQDLx8kx2uQb41XTNZj4HDAmAIHT\",\n \"activated\": true,\n \"banned\": false,\n \"email\": \"documentation_bapi@test.com\",\n \"secret_key\": \"A5DNcYVGCnugYyxexbdjnu7He8GBHJNZuzlRBi0Y\",\n \"uid\": \"mltzba302\",\n \"verified\": false\n}"}],"_postman_id":"6b7aba8c-5f65-4936-907e-8eee39a88bea"}],"id":"a66eba07-1cb6-475c-a73d-eb538c11746b","_postman_id":"a66eba07-1cb6-475c-a73d-eb538c11746b","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","name":"Kyrrex Malta on/off-ramp","type":"collection"}}},{"name":"sessions","item":[{"name":"login","event":[{"listen":"prerequest","script":{"id":"329f2f8c-e2df-4480-b4b3-f37906332258","exec":["const secretKey = pm.collectionVariables.get(\"master_secret_key\");","const method = pm.request.method;","const endpoint = pm.request.url.getPath();","let dataToSign;","","function objectToQueryString(obj) {"," const flatObject = flattenObject(obj);"," const sortedKeys = Object.keys(flatObject).sort();"," const queryParams = sortedKeys.map(key => `${encodeURIComponent(key)}=${encodeURIComponent(flatObject[key])}`);"," return queryParams.join('&');","}","","function flattenObject(obj, parentKey = '', res = {}) {"," for (let key in obj) {"," const propName = parentKey ? parentKey + '_' + key : key;"," if (typeof obj[key] === 'object' && obj[key] !== null && !Array.isArray(obj[key]))"," flattenObject(obj[key], propName, res);"," else"," res[propName] = obj[key];"," }"," return res;","}","","if (method === \"GET\") {"," const queryObj = {};"," "," pm.request.url.query.all().forEach(param => {"," if (param.disabled !== true && param.key !== 'master_access_key' && param.key !== 'nonce') {"," const key = param.key.replace(/\\[\\]$/, '');"," "," if (queryObj[key] === undefined) {"," queryObj[key] = param.value;"," } else if (Array.isArray(queryObj[key])) {"," queryObj[key].push(param.value);"," } else {"," queryObj[key] = [queryObj[key], param.value];"," }"," }"," });"," "," const sortedKeys = Object.keys(queryObj).sort();"," "," dataToSign = sortedKeys.map(key => {"," if (key !== 'master_access_key' && key !== 'nonce') {"," const value = queryObj[key];"," const valueStr = Array.isArray(value) ? value.join(',') : value;"," return `${encodeURIComponent(key)}=${encodeURIComponent(valueStr)}`;"," }"," return '';"," }).filter(item => item !== '').join('&');"," ","} else if ([\"POST\", \"PUT\", \"PATCH\", \"DELETE\"].includes(method)) {"," const requestBody = JSON.parse(pm.request.body.raw || '{}');"," dataToSign = objectToQueryString(requestBody);","}","","const message = `${method}|${endpoint}|${dataToSign}`;","const signature = CryptoJS.HmacSHA256(message, secretKey).toString(CryptoJS.enc.Hex);","pm.collectionVariables.set(\"master_signature\", signature);","console.log(\"String to sign: \" + message);"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"78ea3850-8a78-418c-8ae6-4c685f92f583","exec":["","var responseJson = pm.response.json();","","if (responseJson.access_key && responseJson.secret_key) {"," pm.collectionVariables.set(\"access_key\", responseJson.access_key);"," pm.collectionVariables.set(\"secret_key\", responseJson.secret_key);"," "," console.log(\"access_key:\", responseJson.access_key);"," console.log(\"secret_key:\", responseJson.secret_key);","}"],"type":"text/javascript","packages":{}}}],"id":"52483d50-dc1f-468e-8aa3-1f56fe6efcfb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Auth-Token","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb","type":"text"},{"key":"APISign","value":"","type":"text"},{"key":"APIKey","value":"","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.mt/api/v1/business/sessions","description":"

The endpoint makes an HTTP POST request to create a session at the specified URL. Upon successful execution, the response will have a status code of 201 and a content type of application/json.

The response body will contain a JSON object with the following schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"access_key\": {\n      \"type\": \"string\"\n    },\n    \"created_at\": {\n      \"type\": \"string\"\n    },\n    \"expire_at\": {\n      \"type\": \"string\"\n    },\n    \"secret_key\": {\n      \"type\": \"string\"\n    },\n    \"updated_at\": {\n      \"type\": \"string\"\n    }\n  }\n}\n\n

Delete Session

This endpoint is used to delete a session.

Response

The response for this request is a JSON schema with the following structure:

{\n  \"type\": \"boolean\"\n}\n\n

Get Sessions

This endpoint retrieves a list of sessions with optional pagination parameters.

Request Parameters

page (integer, optional): The page number for the results.
\n
per_page (integer, optional): The number of items per page.
\n

Response

total_count (integer): The total count of sessions.
\n
per_page (integer): The number of items per page.
\n
total_pages (integer): The total number of pages.
\n
page (integer): The current page number.
\n
prev_page (integer or null): The previous page number, or null if no previous page exists.
\n
next_page (integer or null): The next page number, or null if no next page exists.
\n
items (array): An array of session objects with the following attributes:
\n
- access_key (string): The access key for the session.
  \n
- created_at (string): The creation timestamp of the session.
  \n
- expire_at (string): The expiration timestamp of the session.
  \n
- updated_at (string): The update timestamp of the session.
  \n
\n

Get Customer Details

This endpoint retrieves the details of a customer.

Request

Method: GET
\n
URL: https://my.kyrrex.mt/api/v1/business/customer
\n

Response

The response will be a JSON object with the following fields:

address (string, optional): The address of the customer.
\n
city (string, optional): The city of the customer.
\n
country_id (integer): The ID of the country.
\n
country_of_incorporation_id (integer, optional): The ID of the country of incorporation.
\n
dob (string, optional): The date of birth of the customer.
\n
email (string): The email address of the customer.
\n
first_name (string, optional): The first name of the customer.
\n
last_name (string, optional): The last name of the customer.
\n
level_info (object): Information about the customer's level.
\n
phone (string, optional): The phone number of the customer.
\n
place_of_birth_id (integer, optional): The ID of the place of birth.
\n
postcode (string, optional): The postcode of the customer.
\n
terms_accepted (boolean): Indicates if the terms have been accepted.
\n
verification_status (string): The verification status of the customer.
\n

Example response:

{\n    \"address\": null,\n    \"city\": null,\n    \"country_id\": 0,\n    \"country_of_incorporation_id\": null,\n    \"dob\": null,\n    \"email\": \"\",\n    \"first_name\": null,\n    \"last_name\": null,\n    \"level_info\": {},\n    \"phone\": null,\n    \"place_of_birth_id\": null,\n    \"postcode\": null,\n    \"terms_accepted\": true,\n    \"verification_status\": \"\"\n}\n\n

Request

This endpoint makes an HTTP GET request to retrieve a list of countries from the specified base URL. The request does not require any parameters in the request body.

Response

The response will include an array of objects, each representing a country. Each country object will contain the following properties:

code: The country code
\n
eng_name: The English name of the country
\n
id: The unique identifier for the country
\n
iso: The ISO code for the country
\n
location: The location of the country
\n

JSON Schema

[\n    {\n        \"type\": \"object\",\n        \"properties\": {\n            \"code\": {\"type\": \"string\"},\n            \"eng_name\": {\"type\": \"string\"},\n            \"id\": {\"type\": \"integer\"},\n            \"iso\": {\"type\": \"integer\"},\n            \"location\": {\"type\": \"string\"}\n        }\n    }\n]\n\n

Get Countries

This endpoint retrieves a list of countries.

Request Body

This request does not require a request body.

Response

code (string): The country code.
eng_name (string): The English name of the country.
id (integer): The unique identifier for the country.
iso (integer): The ISO code for the country.
location (string): The location of the country.

Example response:

[\n    {\n        \"code\": \"\",\n        \"eng_name\": \"\",\n        \"id\": 0,\n        \"iso\": 0,\n        \"location\": \"\"\n    }\n]\n

Get VASPs Tools

This endpoint makes an HTTP GET request to retrieve a list of VASPs (Virtual Asset Service Providers) tools.

Request Body:\nThis request does not require a request body.

Response:\nThe response will include the following fields:

total_count (number): Total count of VASPs tools.
per_page (number): Number of items per page.
total_pages (number): Total number of pages.
page (number): Current page number.
prev_page (null): Previous page number, if available.
next_page (null): Next page number, if available.
items (array): An array of VASPs tools, each containing:
- id (number): The unique identifier of the VASP tool.
- name (string): The name of the VASP tool.
\n

Example Response:

{\n    \"total_count\": 0,\n    \"per_page\": 0,\n    \"total_pages\": 0,\n    \"page\": 0,\n    \"prev_page\": null,\n    \"next_page\": null,\n    \"items\": [\n        {\n            \"id\": 0,\n            \"name\": \"\"\n        }\n    ]\n}\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","name":"Kyrrex Malta on/off-ramp","type":"collection"}},"urlObject":{"path":["api","v1","business","tools","vasps"],"host":["https://my.kyrrex.mt"],"query":[],"variable":[]}},"response":[{"id":"0a94e6d0-679a-49a1-a435-ab0c591f0be7","name":"vasps","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"APIKey","value":"","type":"text","disabled":true},{"key":"APISign","value":"","type":"text","disabled":true},{"key":"Auth-Token","value":"396a853becbb69c75234e775dac0cba69ef51bfb","type":"text"}],"url":"https://my.kyrrex.mt/api/v1/business/tools/vasps"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 14 Mar 2025 13:06:32 GMT"},{"key":"X-Ratelimit-Remaining","value":"29999"},{"key":"X-Ratelimit-Reset","value":"60"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Ratelimit-Limit","value":"30000"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"96f-4J3msKds7Om+YzmtyXkcGmvElN8\""},{"key":"Vary","value":"accept-encoding"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 92835d2f5794bba6bff3a83645bbf4c4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"VIE50-P1"},{"key":"X-Amz-Cf-Id","value":"O5-0ovaYX31V0wXKFpbtgL8F7c4Xm59hrhX5G_jabUoTcu0vfW2TlA=="}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 70,\n \"per_page\": 100,\n \"total_pages\": 1,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": null,\n \"items\": [\n {\n \"id\": 44,\n \"name\": \"uab_simple_europe TEST\"\n },\n {\n \"id\": 45,\n \"name\": \"BITEXEN TEST VASP\"\n },\n {\n \"id\": 46,\n \"name\": \"Kriptomat\"\n },\n {\n \"id\": 47,\n \"name\": \"Sumsub Compliance TEST VASP\"\n },\n {\n \"id\": 55,\n \"name\": \"Coinify TEST\"\n },\n {\n \"id\": 56,\n \"name\": \"XRP Toolkit\"\n },\n {\n \"id\": 57,\n \"name\": \"OFAC SDN Garantex.io 2022-04-05\"\n },\n {\n \"id\": 58,\n \"name\": \"Coinsdrome TEST\"\n },\n {\n \"id\": 69,\n \"name\": \"UAE 2\"\n },\n {\n \"id\": 2071,\n \"name\": \"AnnaTest\"\n },\n {\n \"id\": 1,\n \"name\": \"Sumsub test VASP\"\n },\n {\n \"id\": 2,\n \"name\": \"Sumsub test VASP sender\"\n },\n {\n \"id\": 3,\n \"name\": \"Dummy\"\n },\n {\n \"id\": 4,\n \"name\": \"test5 Sean java test\"\n },\n {\n \"id\": 5,\n \"name\": \"KuCoin\"\n },\n {\n \"id\": 6,\n \"name\": \"DPR Seized Coins\"\n },\n {\n \"id\": 7,\n \"name\": \"SilkRoad Marketplace\"\n },\n {\n \"id\": 8,\n \"name\": \"Tether USD (USDT)\"\n },\n {\n \"id\": 10,\n \"name\": \"Satoshi Nakamoto\"\n },\n {\n \"id\": 28,\n \"name\": \"Roobet\"\n },\n {\n \"id\": 29,\n \"name\": \"Coinbase.com\"\n },\n {\n \"id\": 30,\n \"name\": \"GateHub TEST\"\n },\n {\n \"id\": 31,\n \"name\": \"Labelrails TEST\"\n },\n {\n \"id\": 32,\n \"name\": \"Binance\"\n },\n {\n \"id\": 33,\n \"name\": \"Ethereum Foundation\"\n },\n {\n \"id\": 34,\n \"name\": \"OFAC: Xiaobing Yan\"\n },\n {\n \"id\": 9,\n \"name\": \"Poloniex\"\n },\n {\n \"id\": 11,\n \"name\": \"Coingate\"\n },\n {\n \"id\": 12,\n \"name\": \"piotr_test\"\n },\n {\n \"id\": 13,\n \"name\": \"Bitstamp\"\n },\n {\n \"id\": 14,\n \"name\": \"beaverbuild.org\"\n },\n {\n \"id\": 15,\n \"name\": \"Bybit\"\n },\n {\n \"id\": 35,\n \"name\": \"dmkotmakovtest\"\n },\n {\n \"id\": 36,\n \"name\": \"Kaurifinance OU Test\"\n },\n {\n \"id\": 37,\n \"name\": \"ETH token\"\n },\n {\n \"id\": 38,\n \"name\": \"CryptoForHealth\"\n },\n {\n \"id\": 39,\n \"name\": \"Rapidz TEST\"\n },\n {\n \"id\": 40,\n \"name\": \"militumtestvasp\"\n },\n {\n \"id\": 16,\n \"name\": \"Nevada\"\n },\n {\n \"id\": 17,\n \"name\": \"Nevada testing\"\n },\n {\n \"id\": 18,\n \"name\": \"ATCoin-Test\"\n },\n {\n \"id\": 19,\n \"name\": \"F2Pool\"\n },\n {\n \"id\": 20,\n \"name\": \"Bitpanda Custody (Prev Trustology)\"\n },\n {\n \"id\": 21,\n \"name\": \"HexTrust\"\n },\n {\n \"id\": 22,\n \"name\": \"Kuna.io TEST VASP\"\n },\n {\n \"id\": 23,\n \"name\": \"Huobi.com\"\n },\n {\n \"id\": 24,\n \"name\": \"TEROXX TEST VASP\"\n },\n {\n \"id\": 25,\n \"name\": \"Coinpass Test\"\n },\n {\n \"id\": 26,\n \"name\": \"CoinMotion\"\n },\n {\n \"id\": 27,\n \"name\": \"Bitpanda TEST\"\n },\n {\n \"id\": 51,\n \"name\": \"Unitic Exchange TEST\"\n },\n {\n \"id\": 52,\n \"name\": \"Freedx TEST\"\n },\n {\n \"id\": 53,\n \"name\": \"HitBTC\"\n },\n {\n \"id\": 54,\n \"name\": \"MEXC Global\"\n },\n {\n \"id\": 41,\n \"name\": \"Bybit TEST\"\n },\n {\n \"id\": 42,\n \"name\": \"Betplay\"\n },\n {\n \"id\": 43,\n \"name\": \"edihendrytest\"\n },\n {\n \"id\": 48,\n \"name\": \"Bitfinex\"\n },\n {\n \"id\": 49,\n \"name\": \"Floin Test VASP\"\n },\n {\n \"id\": 50,\n \"name\": \"Okx.com\"\n },\n {\n \"id\": 59,\n \"name\": \"Kucoin TEST\"\n },\n {\n \"id\": 60,\n \"name\": \"Blockben TEST\"\n },\n {\n \"id\": 61,\n \"name\": \"Nestcoin TEST\"\n },\n {\n \"id\": 62,\n \"name\": \"KuCoin Counterparty TEST VASP\"\n },\n {\n \"id\": 63,\n \"name\": \"Kyrrex TEST\"\n },\n {\n \"id\": 64,\n \"name\": \"Camel Milk VASP\"\n },\n {\n \"id\": 65,\n \"name\": \"Zubbie's VASP\"\n },\n {\n \"id\": 66,\n \"name\": \"Exmo VASP Test\"\n },\n {\n \"id\": 67,\n \"name\": \"Tairn VASP\"\n },\n {\n \"id\": 68,\n \"name\": \"UAE\"\n }\n ]\n}"}],"_postman_id":"0ef23874-3abc-4811-8e35-773fca874fba"},{"name":"timestamp","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"e51b579c-51b0-4c36-9425-32e531469260"}}],"id":"b3149261-d737-47a6-bf34-2944a8db28e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"Auth-Token","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb","type":"text"}],"url":"https://my.kyrrex.mt/api/v1/business/tools/timestamp","description":"

Retrieve Timestamp

This endpoint makes an HTTP GET request to retrieve the current timestamp.

Request

No request body is required for this endpoint.

Response

The response for this request is a JSON object with a single property \"timestamp\", which represents the current timestamp in milliseconds.

{\n    \"timestamp\": 0\n}\n

Get Identification Documents

This endpoint retrieves a list of identification documents.

Request

Method: GET
\n
Endpoint: https://my.kyrrex.mt/api/v1/business/tools/identification_documents
\n

Response

The response for this request can be represented as a JSON schema:

[\n  {\n    \"id\": \"number\",\n    \"name\": \"string\"\n  }\n]\n\n

The response is an array of objects, where each object represents an identification document with its id and name.

This endpoint allows you to make an HTTP POST request to generate a token for KYC (Know Your Customer) purposes.

Request Body

The request should include a JSON body with the necessary parameters to generate the token.

Response

Upon successful execution, the API will respond with a status code of 201 and a JSON object containing the generated token.

Example Response:

{\n    \"token\": \"generated_token_here\"\n}\n\n

This endpoint allows you to generate a web link for the KYC (Know Your Customer) process. The request should be sent via an HTTP POST method to the specified URL.

Request Body

The request should include the necessary parameters in the request body to generate the web link for the KYC process.

Response

The response will have a status code of 201 and a JSON content type. The response body will contain a link attribute which will provide the generated web link for the KYC process.

JSON Schema

{\n    \"type\": \"object\",\n    \"properties\": {\n        \"link\": {\n            \"type\": \"string\"\n        }\n    }\n}\n

This endpoint makes an HTTP GET request to retrieve the KYC (Know Your Customer) levels. The request does not include a request body, and it expects a JSON response with an array of objects containing \"position\" and \"title\" fields.

Request Body

This request does not require a request body.

Response

The response will be a JSON array with objects containing the following fields:

position (number): The position of the KYC level.
\n
title (string): The title of the KYC level.
\n

Example Response

[\n  {\n    \"position\": 1,\n    \"title\": \"Basic\"\n  }\n]\n\n

Retrieve Assets with Active Deposit and Withdrawal

This endpoint makes an HTTP GET request to retrieve a list of assets with active deposit and withdrawal options.

Request Body

active_deposit (boolean, optional): Filter assets with active deposit.
\n
active_withdrawal (boolean, optional): Filter assets with active withdrawal.
\n
page (integer, optional): Page number for paginated results.
\n
per_page (integer, optional): Number of items per page.
\n

Response Body

The response will contain an array of items, each representing an asset with the following properties:

total_count (integer): Total count of assets.
\n
per_page (integer): Number of items per page.
\n
total_pages (integer): Total number of pages.
\n
page (integer): Current page number.
\n
prev_page (null or integer): Previous page number.
\n
next_page (null or integer): Next page number.
\n
items (array): Array of assets with the following properties:
\n
- asset (string): Asset symbol.
  \n
- dchains (array): Array of blockchain details for the asset, including deposit and withdrawal configurations.
  \n
- name (string): Asset name.
  \n
- precision (integer): Precision of the asset.
  \n
- tag (null or string): Tag associated with the asset.
  \n
- type (string): Type of the asset.
  \n
\n

Each dchain object within the items array will have the following properties:

active_deposit (boolean): Indicates if deposit is active for the blockchain.
\n
active_withdrawal (boolean): Indicates if withdrawal is active for the blockchain.
\n
aml_active (boolean): Indicates if AML (Anti-Money Laundering) is active for the blockchain.
\n
chain (string): Blockchain name.
\n
confirmations_deposit (integer): Number of confirmations required for deposits.
\n
confirmations_withdrawal (integer): Number of confirmations required for withdrawals.
\n
contact_aml (string): AML contact information.
\n
contract_address (string): Blockchain contract address.
\n
dchain (string): Blockchain name.
\n
digit (integer): Number of digits for the asset.
\n
display_name (string): Display name for the blockchain.
\n
dtype (string): Type of the blockchain.
\n
min_deposit (string): Minimum deposit amount for the asset.
\n
min_withdrawal (string): Minimum withdrawal amount for the asset.
\n
tag (null or string): Tag associated with the blockchain.
\n
tag_require (boolean): Indicates if tag is required for transactions.
\n
tag_visible (boolean): Indicates if tag is visible for transactions.
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","name":"Kyrrex Malta on/off-ramp","type":"collection"}},"urlObject":{"path":["api","v1","business","assets"],"host":["https://my.kyrrex.mt"],"query":[{"key":"active_deposit","value":"true"},{"key":"active_withdrawal","value":"true"},{"key":"page","value":null},{"key":"per_page","value":null}],"variable":[]}},"response":[{"id":"5b3a353f-7574-4a7b-b402-e86c1ba92e99","name":"list","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"APIKey","value":"","type":"text"},{"key":"APISign","value":"","type":"text"},{"key":"Auth-Token","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb","type":"text"}],"url":{"raw":"https://my.kyrrex.mt/api/v1/business/assets?active_deposit=true&active_withdrawal=true","host":["https://my.kyrrex.mt"],"path":["api","v1","business","assets"],"query":[{"key":"active_deposit","value":"true"},{"key":"active_withdrawal","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 14 Mar 2025 13:45:04 GMT"},{"key":"X-Ratelimit-Remaining","value":"29999"},{"key":"X-Ratelimit-Reset","value":"60"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Ratelimit-Limit","value":"30000"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"19fd-D5dCHoYrE4l4ujV86g0zo9H0Z10\""},{"key":"Vary","value":"accept-encoding"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 f1a22cc8d842b0950e4bd5bda60806f2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"FRA56-P7"},{"key":"X-Amz-Cf-Id","value":"RdUIVkVbJQW0h02d5HM99WTN7bhHd92ASSTIuUqsKwzcyqK71nOxlw=="}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 9,\n \"per_page\": 100,\n \"total_pages\": 1,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": null,\n \"items\": [\n {\n \"asset\": \"btc\",\n \"dchains\": [\n {\n \"active_deposit\": true,\n \"active_withdrawal\": true,\n \"aml_active\": true,\n \"asset\": \"btc\",\n \"chain\": \"\",\n \"confirmations_deposit\": 12,\n \"confirmations_withdrawal\": 12,\n \"contact_aml\": \"@test\",\n \"contract_address\": \"\",\n \"dchain\": \"btc\",\n \"digit\": 8,\n \"display_name\": \"Bitcoin\",\n \"dtype\": \"crypto\",\n \"min_deposit\": \"0.0005\",\n \"min_withdrawal\": \"0.0005\",\n \"tag\": null,\n \"tag_require\": false,\n \"tag_visible\": false\n }\n ],\n \"name\": \"Bitcoin\",\n \"precision\": 8,\n \"tag\": null,\n \"type\": \"crypto\"\n },\n {\n \"asset\": \"ltc\",\n \"dchains\": [\n {\n \"active_deposit\": true,\n \"active_withdrawal\": true,\n \"aml_active\": false,\n \"asset\": \"ltc\",\n \"chain\": \"\",\n \"confirmations_deposit\": 0,\n \"confirmations_withdrawal\": 0,\n \"contact_aml\": \"\",\n \"contract_address\": \"\",\n \"dchain\": \"ltc\",\n \"digit\": 8,\n \"display_name\": \"Litecoin\",\n \"dtype\": \"crypto\",\n \"min_deposit\": \"0.0\",\n \"min_withdrawal\": \"0.01\",\n \"tag\": null,\n \"tag_require\": false,\n \"tag_visible\": false\n }\n ],\n \"name\": \"ltc\",\n \"precision\": 8,\n \"tag\": null,\n \"type\": \"crypto\"\n },\n {\n \"asset\": \"eth\",\n \"dchains\": [\n {\n \"active_deposit\": true,\n \"active_withdrawal\": true,\n \"aml_active\": true,\n \"asset\": \"eth\",\n \"chain\": \"\",\n \"confirmations_deposit\": 0,\n \"confirmations_withdrawal\": 0,\n \"contact_aml\": \"@test\",\n \"contract_address\": \"\",\n \"dchain\": \"eth\",\n \"digit\": 8,\n \"display_name\": \"Ethereum\",\n \"dtype\": \"crypto\",\n \"min_deposit\": \"0.0\",\n \"min_withdrawal\": \"0.01\",\n \"tag\": null,\n \"tag_require\": false,\n \"tag_visible\": false\n }\n ],\n \"name\": \"eth\",\n \"precision\": 8,\n \"tag\": null,\n \"type\": \"crypto\"\n },\n {\n \"asset\": \"xlm\",\n \"dchains\": [\n {\n \"active_deposit\": true,\n \"active_withdrawal\": true,\n \"aml_active\": true,\n \"asset\": \"xlm\",\n \"chain\": \"\",\n \"confirmations_deposit\": 0,\n \"confirmations_withdrawal\": 0,\n \"contact_aml\": \"\",\n \"contract_address\": \"\",\n \"dchain\": \"xlm\",\n \"digit\": 7,\n \"display_name\": \"Stellar\",\n \"dtype\": \"crypto\",\n \"min_deposit\": \"0.0\",\n \"min_withdrawal\": \"5.0\",\n \"tag\": null,\n \"tag_require\": true,\n \"tag_visible\": true\n }\n ],\n \"name\": \"xlm\",\n \"precision\": 8,\n \"tag\": null,\n \"type\": \"crypto\"\n },\n {\n \"asset\": \"usdc\",\n \"dchains\": [\n {\n \"active_deposit\": true,\n \"active_withdrawal\": true,\n \"aml_active\": true,\n \"asset\": \"usdc\",\n \"chain\": \"\",\n \"confirmations_deposit\": 5,\n \"confirmations_withdrawal\": 5,\n \"contact_aml\": \"\",\n \"contract_address\": \"0x1de5e66c77c82ca83dbc005e6d5b7a29f9c92881\",\n \"dchain\": \"usdc\",\n \"digit\": 8,\n \"display_name\": \"USD COIN ERC20\",\n \"dtype\": \"crypto\",\n \"min_deposit\": \"10.0\",\n \"min_withdrawal\": \"10.0\",\n \"tag\": null,\n \"tag_require\": false,\n \"tag_visible\": false\n }\n ],\n \"name\": \"USD COIN ERC20\",\n \"precision\": 8,\n \"tag\": \"\",\n \"type\": \"crypto\"\n },\n {\n \"asset\": \"xrp\",\n \"dchains\": [\n {\n \"active_deposit\": true,\n \"active_withdrawal\": true,\n \"aml_active\": false,\n \"asset\": \"xrp\",\n \"chain\": \"\",\n \"confirmations_deposit\": 1,\n \"confirmations_withdrawal\": 1,\n \"contact_aml\": \"\",\n \"contract_address\": \"\",\n \"dchain\": \"xrp\",\n \"digit\": 6,\n \"display_name\": \"Ripple\",\n \"dtype\": \"crypto\",\n \"min_deposit\": \"0.0\",\n \"min_withdrawal\": \"20.0\",\n \"tag\": \"\",\n \"tag_require\": false,\n \"tag_visible\": false\n }\n ],\n \"name\": \"xrp\",\n \"precision\": 6,\n \"tag\": \"\",\n \"type\": \"crypto\"\n },\n {\n \"asset\": \"bch\",\n \"dchains\": [\n {\n \"active_deposit\": true,\n \"active_withdrawal\": true,\n \"aml_active\": false,\n \"asset\": \"bch\",\n \"chain\": \"\",\n \"confirmations_deposit\": 0,\n \"confirmations_withdrawal\": 0,\n \"contact_aml\": \"\",\n \"contract_address\": \"\",\n \"dchain\": \"bch\",\n \"digit\": 8,\n \"display_name\": \"Bitcoin Cash\",\n \"dtype\": \"crypto\",\n \"min_deposit\": \"0.0\",\n \"min_withdrawal\": \"0.016\",\n \"tag\": \"\",\n \"tag_require\": false,\n \"tag_visible\": false\n }\n ]\n"}],"_postman_id":"c7f09216-e254-4fc4-bb07-77fcbb88a892"},{"name":"info","id":"e9779420-b542-4086-afbd-625e354030ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v1/business/assets/:code","description":"

The endpoint retrieves information about a specific asset identified by its code. The response is a JSON object containing details about the asset, including its name, precision, and type. Additionally, it includes an array of dchains, each providing information about the asset's chain, deposit and withdrawal configurations, AML status, and other related attributes.

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"asset\": { \"type\": \"string\" },\n    \"dchains\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"active_deposit\": { \"type\": \"boolean\" },\n          \"active_withdrawal\": { \"type\": \"boolean\" },\n          \"aml_active\": { \"type\": \"boolean\" },\n          \"asset\": { \"type\": \"string\" },\n          \"chain\": { \"type\": \"string\" },\n          \"confirmations_deposit\": { \"type\": \"integer\" },\n          \"confirmations_withdrawal\": { \"type\": \"integer\" },\n          \"contact_aml\": { \"type\": \"string\" },\n          \"contract_address\": { \"type\": \"string\" },\n          \"dchain\": { \"type\": \"string\" },\n          \"digit\": { \"type\": \"integer\" },\n          \"display_name\": { \"type\": \"string\" },\n          \"dtype\": { \"type\": \"string\" },\n          \"min_deposit\": { \"type\": \"string\" },\n          \"min_withdrawal\": { \"type\": \"string\" },\n          \"tag\": { \"type\": \"string\" },\n          \"tag_require\": { \"type\": \"boolean\" },\n          \"tag_visible\": { \"type\": \"boolean\" }\n        }\n      }\n    },\n    \"name\": { \"type\": \"string\" },\n    \"precision\": { \"type\": \"integer\" },\n    \"tag\": { \"type\": \"string\" },\n    \"type\": { \"type\": \"string\" }\n  }\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","name":"Kyrrex Malta on/off-ramp","type":"collection"}},"urlObject":{"path":["api","v1","business","assets",":code"],"host":["https://my.kyrrex.mt"],"query":[],"variable":[{"id":"e696003f-703c-4c4e-b8f4-8e9cc0a91769","type":"any","value":"","key":"code"}]}},"response":[{"id":"606d06d1-0e7f-4703-af5e-0c68e3a6b502","name":"info","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.mt/api/v1/business/assets/:code","protocol":"https","host":["my","kyrrex","mt"],"path":["api","v1","business","assets",":code"],"variable":[{"key":"code","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"asset\": \"usdt\",\r\n\t\"dchains\": [\r\n\t\t{\r\n\t\t\t\"active_deposit\": true,\r\n\t\t\t\"active_withdrawal\": true,\r\n\t\t\t\"aml_active\": false,\r\n\t\t\t\"asset\": \"usdt\",\r\n\t\t\t\"chain\": \"\",\r\n\t\t\t\"confirmations_deposit\": 4,\r\n\t\t\t\"confirmations_withdrawal\": 4,\r\n\t\t\t\"contact_aml\": \"\",\r\n\t\t\t\"contract_address\": \"\",\r\n\t\t\t\"dchain\": \"trc20usdt\",\r\n\t\t\t\"digit\": 8,\r\n\t\t\t\"display_name\": \"TRC20\",\r\n\t\t\t\"dtype\": \"crypto\",\r\n\t\t\t\"min_deposit\": \"0.0\",\r\n\t\t\t\"min_withdrawal\": \"11.0\",\r\n\t\t\t\"tag\": \"\",\r\n\t\t\t\"tag_require\": false,\r\n\t\t\t\"tag_visible\": false\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"active_deposit\": true,\r\n\t\t\t\"active_withdrawal\": true,\r\n\t\t\t\"aml_active\": false,\r\n\t\t\t\"asset\": \"usdt\",\r\n\t\t\t\"chain\": \"\",\r\n\t\t\t\"confirmations_deposit\": 1,\r\n\t\t\t\"confirmations_withdrawal\": 2,\r\n\t\t\t\"contact_aml\": \"\",\r\n\t\t\t\"contract_address\": \"\",\r\n\t\t\t\"dchain\": \"usdterc20\",\r\n\t\t\t\"digit\": 6,\r\n\t\t\t\"display_name\": \"ERC20\",\r\n\t\t\t\"dtype\": \"crypto\",\r\n\t\t\t\"min_deposit\": \"10.0\",\r\n\t\t\t\"min_withdrawal\": \"16.0\",\r\n\t\t\t\"tag\": \"\",\r\n\t\t\t\"tag_require\": false,\r\n\t\t\t\"tag_visible\": false\r\n\t\t}\r\n\t],\r\n\t\"name\": \"usdt\",\r\n\t\"precision\": 8,\r\n\t\"tag\": \"\",\r\n\t\"type\": \"crypto\"\r\n}"}],"_postman_id":"e9779420-b542-4086-afbd-625e354030ec"}],"id":"6f98d1bb-a533-435a-b02b-ef40b37ca2ad","_postman_id":"6f98d1bb-a533-435a-b02b-ef40b37ca2ad","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","name":"Kyrrex Malta on/off-ramp","type":"collection"}}},{"name":"requisites","item":[{"name":"create","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"0d52dd8c-6a9c-443f-b32c-84324cab3a86"}}],"id":"6bc8417d-d790-40d8-8855-b5860769422e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"APIKey","value":"","type":"text"},{"key":"APISign","value":"","type":"text"},{"key":"Auth-Token","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb","type":"text"}],"body":{"mode":"raw","raw":"{\n // Required\n \"name\": \"string (required)\",\n \"address\": \"string (required)\",\n \"dchain\": \"string (required)\",\n\n // Optional\n \"tag\": \"string (optional)\",\n \"description\": \"string (optional)\",\n \"wallet_type\": \"string (required for Malta)\",\n \"control\": true, // required for Malta\n\n \"owner_type\": \"personal\", // required if control = false or for Malta\n\n // If owner_type = \"legal\"\n \"owner_lei_number\": \"string\", // required\n \"owner_company_name\": \"string\", // required\n\n // If owner_type = \"personal\"\n \"owner_first_name\": \"string\", // required\n \"owner_last_name\": \"string\", // required\n \"owner_dob\": \"string\", // required\n \"owner_address_country\": \"string\", // required\n \"owner_address_city\": \"string\", // required\n \"owner_address_street\": \"string\", // required\n \"owner_address_postcode\": \"string\", // required\n \"owner_document_id\": \"string\", // required\n \"owner_document_number\": \"string\", // required\n\n // One of the two is required for Malta\n \"vasp_id\": 123, // required if no other_cex_name\n \"other_cex_name\": \"string\" // required if no vasp_id\n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.mt/api/v1/business/requisites","description":"

Create Requisites

This endpoint allows you to create requisites by sending a POST request to the specified URL.

Request Body

name (string, required): The name of the requisite.
\n
address (string, required): The address for the requisite.
\n
dchain (string, required): The blockchain for the requisite.
\n
tag (string, optional): The tag associated with the requisite.
\n
description (string, optional): The description of the requisite.
\n
wallet_type (string, required for Malta): The type of wallet for the requisite.
\n
control (boolean): Indicates whether the requisite is under control.
\n
owner_type (string): Type of the owner (e.g., personal or company).
\n
owner_lei_number (string): LEI number of the owner.
\n
owner_company_name (string): Name of the owner's company.
\n
owner_first_name (string): First name of the owner.
\n
owner_last_name (string): Last name of the owner.
\n
owner_dob (string): Date of birth of the owner.
\n
owner_address_country (string): Country of the owner's address.
\n
owner_address_city (string): City of the owner's address.
\n
owner_address_street (string): Street of the owner's address.
\n
owner_address_postcode (string): Postcode of the owner's address.
\n
owner_document_id (string): ID of the owner's document.
\n
owner_document_number (string): Number of the owner's document.
\n
vasp_id (number): The ID of the VASP.
\n
other_cex_name (string): The name of the requisite in another exchange.
\n

Response

{\n  \"address\": \"string\",\n  \"asset\": \"string\",\n  \"control\": true,\n  \"created_at\": \"string\",\n  \"dchain\": \"string\",\n  \"deleted_at\": \"string\",\n  \"description\": \"string\",\n  \"name\": \"string\",\n  \"other_cex_name\": \"string\",\n  \"requisite_additional_information\": {\n    \"id\": 0,\n    \"owner_first_name\": \"string\",\n    \"owner_last_name\": \"string\",\n    \"owner_document_id\": \"string\",\n    \"owner_document_number\": \"string\",\n    \"owner_email\": \"string\",\n    \"owner_dob\": \"string\",\n    \"owner_address_city\": \"string\",\n    \"owner_address_street\": \"string\",\n    \"owner_address_postcode\": \"string\",\n    \"service_id\": \"string\",\n    \"created_at\": \"string\",\n    \"updated_at\": \"string\",\n    \"requisite_id\": 0,\n    \"owner_nationality\": \"string\",\n    \"owner_address_country\": \"string\",\n    \"provider_id\": \"string\",\n    \"uid\": \"string\",\n    \"owner_type\": \"string\",\n    \"owner_lei_number\": \"string\",\n    \"owner_company_name\": \"string\"\n  },\n  \"tag\": \"string\",\n  \"uid\": \"string\",\n  \"updated_at\": \"string\",\n  \"wallet_type\": \"string\"\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","name":"Kyrrex Malta on/off-ramp","type":"collection"}},"urlObject":{"path":["api","v1","business","requisites"],"host":["https://my.kyrrex.mt"],"query":[],"variable":[]}},"response":[{"id":"279bd28e-6063-4d88-b312-6b2b4ce62bf0","name":"Control - True","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"APIKey","value":"","type":"text"},{"key":"APISign","value":"","type":"text"},{"key":"Auth-Token","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb","type":"text"}],"body":{"mode":"raw","raw":"{\n \"address\": \"2N4KRKba8kAcSiKAu3CX6tJz3VKnghrsmj5\",\n \"name\": \"usdc d\",\n \"dchain\": \"usdc\",\n \"wallet_type\": \"custodial\",\n \"vasp_id\": \"15\",\n \"control\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.mt/api/v1/business/requisites"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"354"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 14 Mar 2025 15:36:37 GMT"},{"key":"X-Ratelimit-Reset","value":"32"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Etag","value":"W/\"162-WZCZ+pFf5l7NBZuLmU6aDra4KbM\""},{"key":"X-Ratelimit-Limit","value":"30000"},{"key":"X-Ratelimit-Remaining","value":"29998"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 04bd924a346a4c275fc7e49401769a76.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR5-P6"},{"key":"X-Amz-Cf-Id","value":"lwRZr0gd8igcrC05cB36t1GvAsT4TgmRnCCAxxGkLPwa4fm4hq1Thg=="}],"cookie":[],"responseTime":null,"body":"{\n \"address\": \"2N4KRKba8kAcSiKAu3CX6tJz3VKnghrsmj5\",\n \"asset\": \"usdc\",\n \"control\": true,\n \"created_at\": \"2025-03-14T15:36:37.731Z\",\n \"dchain\": \"usdc\",\n \"deleted_at\": null,\n \"description\": null,\n \"name\": \"usdc d\",\n \"other_cex_name\": null,\n \"requisite_additional_information\": null,\n \"tag\": null,\n \"uid\": \"155-90964380\",\n \"updated_at\": \"2025-03-14T15:36:37.744Z\",\n \"wallet_type\": \"custodial\"\n}"},{"id":"da42d8ce-e6c5-48fb-b304-643fbf3414de","name":"Control - False","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"APIKey","value":"","type":"text"},{"key":"APISign","value":"","type":"text"},{"key":"Auth-Token","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb","type":"text"}],"body":{"mode":"raw","raw":"{\n \"address\": \"TWGwhXzuFMUC2v9FFKCvhjiaaqRzRBNuy2\",\n \"name\": \"trx address1\",\n \"dchain\": \"trc20usdt\",\n \"wallet_type\": \"custodial\",\n \"control\": false,\n \"vasp_id\": 46,\n \"owner_type\": \"personal\",\n \"owner_first_name\": \"Helen\",\n \"owner_last_name\": \"Tester\",\n \"owner_dob\": \"2007-03-07\",\n \"owner_address_country\": \"UKR\",\n \"owner_address_city\": \"Kiev\",\n \"owner_address_street\": \"Saint 44\", \n \"owner_address_postcode\": \"75005\",\n \"owner_document_id\": \"2\",\n \"owner_document_number\": \"DF121312331\" \n}","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.mt/api/v1/business/requisites"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"address\": \"TWGwhXzuFMUC2v9FFKCvhjiaaqRzRBNuy2\",\n \"asset\": \"usdt\",\n \"control\": false,\n \"created_at\": \"2025-03-17T13:57:04.504Z\",\n \"dchain\": \"trc20usdt\",\n \"deleted_at\": null,\n \"description\": null,\n \"name\": \"trx address1\",\n \"other_cex_name\": null,\n \"requisite_additional_information\": {\n \"id\": 884,\n \"owner_first_name\": \"Helen\",\n \"owner_last_name\": \"Tester\",\n \"owner_document_id\": \"2\",\n \"owner_document_number\": \"DF121312331\",\n \"owner_email\": null,\n \"owner_dob\": \"2007-03-07\",\n \"owner_address_city\": \"Kiev\",\n \"owner_address_street\": \"Saint 44\",\n \"owner_address_postcode\": \"75005\",\n \"service_id\": null,\n \"created_at\": \"2025-03-17T13:57:04.565Z\",\n \"updated_at\": \"2025-03-17T13:57:04.578Z\",\n \"requisite_id\": 1890,\n \"owner_nationality\": null,\n \"owner_address_country\": \"UKR\",\n \"provider_id\": null,\n \"uid\": \"253-135362\",\n \"owner_type\": \"personal\",\n \"owner_lei_number\": null,\n \"owner_company_name\": null\n },\n \"tag\": null,\n \"uid\": \"155-90975726\",\n \"updated_at\": \"2025-03-17T13:57:04.527Z\",\n \"wallet_type\": \"custodial\"\n}"}],"_postman_id":"6bc8417d-d790-40d8-8855-b5860769422e"},{"name":"delete","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"0f3ede19-448b-4720-ba3d-c207ce05239e"}}],"id":"bb74bd21-d1b6-4689-af97-7b21d3fdeb21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"accept","value":"application/json"},{"key":"APIKey","value":"","type":"text"},{"key":"APISign","value":"","type":"text"},{"key":"Auth-Token","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb","type":"text"}],"url":"https://my.kyrrex.mt/api/v1/business/requisites/:uid","description":"

Delete Requisite

This endpoint is used to delete a specific requisite identified by its unique identifier (uid).

Request Body

This request does not require a request body.

Response

address (string): The address associated with the requisite.
\n
asset (string): The asset information.
\n
control (boolean): Indicates if the requisite is under control.
\n
created_at (string): The creation timestamp of the requisite.
\n
dchain (string): The dchain information.
\n
deleted_at (string): The timestamp when the requisite was deleted.
\n
description (string, null): The description of the requisite, if available.
\n
name (string): The name of the requisite.
\n
other_cex_name (string, null): The name of the requisite in another CEX.
\n
requisite_additional_information (string, null): Additional information related to the requisite.
\n
tag (string, null): The tag associated with the requisite.
\n
uid (string): The unique identifier of the requisite.
\n
updated_at (string): The timestamp when the requisite was last updated.
\n
wallet_type (string): The type of wallet associated with the requisite.
\n

Update Requisites

This endpoint allows you to update the requisites using a PATCH request.

Request Body

uid (string): The unique identifier of the requisite.
\n
name (string): The name of the requisite.
\n

Response

The response will be in the form of a JSON schema with the following properties:

address (string): The address associated with the requisite.
\n
asset (string): The asset related to the requisite.
\n
control (boolean): Indicates whether the requisite has control.
\n
created_at (string): The timestamp of when the requisite was created.
\n
dchain (string): The blockchain associated with the requisite.
\n
deleted_at (null or string): The timestamp of when the requisite was deleted, if applicable.
\n
description (null or string): Additional description of the requisite.
\n
name (string): The name of the requisite.
\n
other_cex_name (null or string): The name of the requisite in another cryptocurrency exchange.
\n
requisite_additional_information (null or string): Additional information related to the requisite.
\n
tag (null or string): Tag associated with the requisite.
\n
uid (string): The unique identifier of the requisite.
\n
updated_at (string): The timestamp of when the requisite was last updated.
\n
wallet_type (string): The type of wallet associated with the requisite.
\n

Example Response

{\n  \"address\": \"\",\n  \"asset\": \"\",\n  \"control\": true,\n  \"created_at\": \"\",\n  \"dchain\": \"\",\n  \"deleted_at\": null,\n  \"description\": null,\n  \"name\": \"\",\n  \"other_cex_name\": null,\n  \"requisite_additional_information\": null,\n  \"tag\": null,\n  \"uid\": \"\",\n  \"updated_at\": \"\",\n  \"wallet_type\": \"\"\n}\n\n

This endpoint retrieves a list of requisites via an HTTP GET request to https://my.kyrrex.mt/api/v1/business/requisites.

Response

total_count (number): The total count of requisites.
\n
per_page (number): The number of requisites per page.
\n
total_pages (number): The total number of pages.
\n
page (number): The current page number.
\n
prev_page (null): The previous page number, if available.
\n
next_page (null): The next page number, if available.
\n
items (array): An array containing the requisites with the following properties:
\n
- address (string): The address associated with the requisite.
  \n
- asset (string): The asset associated with the requisite.
  \n
- control (boolean): Indicates if the requisite is under control.
  \n
- created_at (string): The creation timestamp of the requisite.
  \n
- dchain (string): The blockchain associated with the requisite.
  \n
- deleted_at (null): The deletion timestamp of the requisite, if deleted.
  \n
- description (null): The description of the requisite, if available.
  \n
- name (string): The name of the requisite.
  \n
- other_cex_name (null): The name of the requisite in another exchange, if available.
  \n
- requisite_additional_information (null): Additional information related to the requisite, if available.
  \n
- tag (null): The tag associated with the requisite, if available.
  \n
- uid (string): The unique identifier of the requisite.
  \n
- updated_at (string): The timestamp when the requisite was last updated.
  \n
- wallet_type (string): The type of wallet associated with the requisite.
  \n
\n

This endpoint retrieves a list of requisites.

Request

Method: GET
\n
URL: https://my.kyrrex.mt/api/v1/business/requisites
\n

Response

The response will be a JSON object with the following schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"total_count\": {\n      \"type\": \"integer\"\n    },\n    \"per_page\": {\n      \"type\": \"integer\"\n    },\n    \"total_pages\": {\n      \"type\": \"integer\"\n    },\n    \"page\": {\n      \"type\": \"integer\"\n    },\n    \"prev_page\": {\n      \"type\": \"null\"\n    },\n    \"next_page\": {\n      \"type\": \"null\"\n    },\n    \"items\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"address\": {\n            \"type\": \"string\"\n          },\n          \"asset\": {\n            \"type\": \"string\"\n          },\n          \"control\": {\n            \"type\": \"boolean\"\n          },\n          \"created_at\": {\n            \"type\": \"string\"\n          },\n          \"dchain\": {\n            \"type\": \"string\"\n          },\n          \"deleted_at\": {\n            \"type\": [\"string\", \"null\"]\n          },\n          \"description\": {\n            \"type\": [\"string\", \"null\"]\n          },\n          \"name\": {\n            \"type\": \"string\"\n          },\n          \"other_cex_name\": {\n            \"type\": [\"string\", \"null\"]\n          },\n          \"requisite_additional_information\": {\n            \"type\": [\"string\", \"null\"]\n          },\n          \"tag\": {\n            \"type\": [\"string\", \"null\"]\n          },\n          \"uid\": {\n            \"type\": \"string\"\n          },\n          \"updated_at\": {\n            \"type\": \"string\"\n          },\n          \"wallet_type\": {\n            \"type\": \"string\"\n          }\n        },\n        \"required\": [\"address\", \"asset\", \"control\", \"created_at\", \"dchain\", \"name\", \"uid\", \"updated_at\", \"wallet_type\"]\n      }\n    }\n  },\n  \"required\": [\"total_count\", \"per_page\", \"total_pages\", \"page\", \"prev_page\", \"next_page\", \"items\"]\n}\n\n

asc\\desc

\n","type":"text/plain"},"key":"sort","value":null},{"disabled":true,"description":{"content":"

allowed values - asset/dchain/ address/whitelist name/ wallet_type/state/created_at

\n","type":"text/plain"},"key":"sort_by","value":null},{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[{"id":"53149974-f962-4f66-801d-891e47019720","name":"list","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"APIKey","value":"","type":"text"},{"key":"APISign","value":"","type":"text"},{"key":"Auth-Token","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb","type":"text"}],"url":"https://my.kyrrex.mt/api/v1/business/requisites"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"456"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 14 Mar 2025 15:36:46 GMT"},{"key":"X-Ratelimit-Reset","value":"12"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"1c8-THSbWzFiKsfkzmxZsLFc9ET6eqg\""},{"key":"X-Ratelimit-Limit","value":"30000"},{"key":"X-Ratelimit-Remaining","value":"29998"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 04bd924a346a4c275fc7e49401769a76.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR5-P6"},{"key":"X-Amz-Cf-Id","value":"D-W6h8xUQ4AVuQQ8TRKG2RToV72T9QXy712Lte57v0qI8F4A1Ao_lg=="}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 1,\n \"per_page\": 100,\n \"total_pages\": 1,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": null,\n \"items\": [\n {\n \"address\": \"2N4KRKba8kAcSiKAu3CX6tJz3VKnghrsmj5\",\n \"asset\": \"usdc\",\n \"control\": true,\n \"created_at\": \"2025-03-14T15:36:37.731Z\",\n \"dchain\": \"usdc\",\n \"deleted_at\": null,\n \"description\": null,\n \"name\": \"usdc d\",\n \"other_cex_name\": null,\n \"requisite_additional_information\": null,\n \"tag\": null,\n \"uid\": \"155-90964380\",\n \"updated_at\": \"2025-03-14T15:36:37.744Z\",\n \"wallet_type\": \"custodial\"\n }\n ]\n}"}],"_postman_id":"a3dddee1-d790-4cea-9cb4-050cf1a52c34"}],"id":"4ede5207-ca48-40c8-a7a2-b4233acf6b84","_postman_id":"4ede5207-ca48-40c8-a7a2-b4233acf6b84","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","name":"Kyrrex Malta on/off-ramp","type":"collection"}}},{"name":"withdrawals","item":[{"name":"list","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"ec31e6b4-092c-484d-9321-6c8686700d0d"}}],"id":"080e2ca5-973b-458e-9d82-004dad222778","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"APIKey","value":"","type":"text"},{"key":"APISign","value":"","type":"text"},{"key":"Auth-Token","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb","type":"text"}],"url":"https://my.kyrrex.mt/api/v1/business/withdrawals?asset&status&page&per_page&from&to&sort&sort_by","description":"

Withdrawals API

This API endpoint is used to retrieve withdrawal information.

Request

Method: GET
\n
URL: https://my.kyrrex.mt/api/v1/business/withdrawals
\n
Query Parameters:
\n
- asset (optional): The asset for which withdrawals are to be retrieved.
  \n
- status (optional): The status of the withdrawals.
  \n
- page (optional): The page number for paginated results.
  \n
- per_page (optional): The number of results to be shown per page.
  \n
- from (optional): The start date for the retrieval of withdrawals.
  \n
- to (optional): The end date for the retrieval of withdrawals.
  \n
- sort (optional): The sort order for the results.
  \n
- sort_by (optional): The attribute by which the results are to be sorted.
  \n
\n

Response

The response will be in JSON format with the following schema:

{\n  \"total_count\": {\n    \"type\": \"number\"\n  },\n  \"per_page\": {\n    \"type\": \"number\"\n  },\n  \"total_pages\": {\n    \"type\": \"number\"\n  },\n  \"page\": {\n    \"type\": \"number\"\n  },\n  \"items\": {\n    \"type\": \"array\",\n    \"items\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"address\": {\n          \"type\": \"string\"\n        },\n        \"amount\": {\n          \"type\": \"string\"\n        },\n        \"asset\": {\n          \"type\": \"string\"\n        },\n        \"control\": {\n          \"type\": \"null\"\n        },\n        \"created_at\": {\n          \"type\": \"string\"\n        },\n        \"dchain\": {\n          \"type\": \"string\"\n        },\n        \"done_at\": {\n          \"type\": \"string\"\n        },\n        \"fee\": {\n          \"type\": \"string\"\n        },\n        \"high_risk\": {\n          \"type\": \"null\"\n        },\n        \"status\": {\n          \"type\": \"string\"\n        },\n        \"tag\": {\n          \"type\": \"null\"\n        },\n        \"tx_id\": {\n          \"type\": \"string\"\n        },\n        \"tx_link\": {\n          \"type\": \"string\"\n        },\n        \"type\": {\n          \"type\": \"string\"\n        },\n        \"updated_at\": {\n          \"type\": \"string\"\n        },\n        \"uid\": {\n          \"type\": \"string\"\n        }\n      }\n    }\n  }\n}\n\n

This API endpoint is used to retrieve withdrawal information.

Request

Method: GET
\n
URL: https://my.kyrrex.mt/api/v1/business/withdrawals
\n
Query Parameters:
\n
- asset (optional): The asset for which withdrawals are to be retrieved.
  \n
- status (optional): The status of the withdrawals.
  \n
- page (optional): The page number for paginated results.
  \n
- per_page (optional): The number of results to be shown per page.
  \n
- from (optional): The start date for the retrieval of withdrawals.
  \n
- to (optional): The end date for the retrieval of withdrawals.
  \n
- sort (optional): The sort order for the results.
  \n
- sort_by (optional): The attribute by which the results are to be sorted.
  \n
\n

Response

The response will be in JSON format with the following schema:

{\n  \"total_count\": 0,\n  \"per_page\": 0,\n  \"total_pages\": 0,\n  \"page\": 0,\n  \"items\": [\n    {\n      \"address\": \"\",\n      \"amount\": \"\",\n      \"asset\": \"\",\n      \"control\": null,\n      \"created_at\": \"\",\n      \"dchain\": \"\",\n      \"done_at\": \"\",\n      \"fee\": \"\",\n      \"high_risk\": null,\n      \"status\": \"\",\n      \"tag\": null,\n      \"tx_id\": \"\",\n      \"tx_link\": \"\",\n      \"type\": \"\",\n      \"updated_at\": \"\",\n      \"uid\": \"\"\n    }\n  ]\n}\n\n

Response parameters:

total_count — total number of records
\n
per_page — number of records per page
\n
total_pages — total number of pages
\n
page — current page number
\n
items — list of deposit actions:
\n
address — wallet address
\n
amount — transaction amount
\n
asset — asset type (e.g., BTC, USDT)
\n
control — control flag or object (if any)
\n
created_at — creation date
\n
dchain — blockchain network
\n
done_at — completion date
\n
fee — transaction fee
\n
high_risk — high-risk flag (if applicable)
\n
status — current status
\n
tag — tag/memo (used for some assets like XRP)
\n
tx_id — transaction ID
\n
tx_link — link to transaction explorer
\n
type — action type
\n
updated_at — last update date
\n
uid — unique deposit identifier
\n

Request

This HTTP GET request is used to retrieve withdrawal details for a specific user with the given unique identifier (uid). The request should be made to the endpoint https://my.kyrrex.mt/api/v1/business/withdrawals/:uid, where :uid should be replaced with the actual user identifier.

Request Body

The request does not require any specific input parameters in the query string or request body.

Response

Upon a successful request, the response will include the withdrawal details for the specified user in JSON format. The response will contain the following fields:

\"address\": The withdrawal address.
\n
\"amount\": The amount of the withdrawal.
\n
\"asset\": The asset type of the withdrawal.
\n
\"control\": Indicates if the withdrawal is under control.
\n
\"created_at\": The timestamp when the withdrawal was created.
\n
\"dchain\": The ID associated with the withdrawal on the blockchain.
\n
\"done_at\": The timestamp when the withdrawal was completed.
\n
\"fee\": The fee associated with the withdrawal.
\n
\"high_risk\": Indicates if the withdrawal is flagged as high risk.
\n
\"status\": The status of the withdrawal.
\n
\"tag\": Additional tag associated with the withdrawal.
\n
\"tx_id\": The transaction ID of the withdrawal.
\n
\"tx_link\": The link to the transaction details.
\n
\"type\": The type of withdrawal.
\n
\"updated_at\": The timestamp when the withdrawal details were last updated.
\n
\"uid\": The unique identifier of the user for whom the withdrawal details are retrieved.
\n

Note: Some fields may have null values if the information is not available.

Get Withdrawal Actions

This endpoint retrieves the withdrawal actions for a specific user.

Response

The response for this request follows the JSON schema below:

{\n  \"type\": \"array\",\n  \"items\": {\n    \"type\": \"object\",\n    \"properties\": {\n      \"level_name\": {\n        \"type\": \"string\"\n      },\n      \"action_id\": {\n        \"type\": \"string\"\n      }\n    }\n  }\n}\n\n

The POST request to https://my.kyrrex.mt/api/v1/business/withdrawals/:uid/actions/:action_id/generate_web_link endpoint is used to generate a web link for a specific withdrawal action.

Request Parameters

uid (path parameter): The unique identifier of the user.
\n
action_id (path parameter): The identifier of the withdrawal action.
\n

Response

The response for this request is a JSON object with a link property, which represents the generated web link.

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"link\": {\n      \"type\": \"string\"\n    }\n  }\n}\n\n

Generate Token for Withdrawal Action

This endpoint is used to generate a token for a specific withdrawal action.

Request Body

uid (string) - The unique identifier for the user.
\n
action_id (string) - The identifier for the withdrawal action.
\n

Response

token (string) - The generated token for the withdrawal action.

Example:

{\n    \"token\": \"generated_token_value\"\n}\n\n

Withdrawal Request

This endpoint allows you to initiate a withdrawal by submitting a POST request to the specified URL.

Request Body

dchain (string): The blockchain identifier for the withdrawal.
\n
amount (number): The amount to be withdrawn.
\n
requisite_uid (string): The unique identifier for the withdrawal requisition.
\n

The request body should be in raw format and include the following parameters:

{\n    \"dchain\": \"trx\",\n    \"amount\": 500,\n    \"requisite_uid\": \"155-90968100\"\n}\n\n

Response

Upon successful execution, the server will respond with a status code of 201 and a JSON object containing the withdrawal details, including:

address (string): The withdrawal address.
\n
amount (string): The withdrawn amount.
\n
asset (string): The asset type.
\n
control (null): Control information.
\n
created_at (string): Timestamp of creation.
\n
dchain (string): The blockchain ID.
\n
done_at (string): Timestamp of completion.
\n
fee (string): The withdrawal fee.
\n
high_risk (null): High risk indicator.
\n
status (null): Status of the withdrawal.
\n
tag (null): Tag information.
\n
tx_id (null): Transaction ID.
\n
tx_link (null): Transaction link.
\n
type (string): Type of transaction.
\n
updated_at (string): Timestamp of update.
\n
uid (string): Unique identifier for the withdrawal.
\n

Example Response

{\n    \"address\": \"\",\n    \"amount\": \"\",\n    \"asset\": \"\",\n    \"control\": null,\n    \"created_at\": \"\",\n    \"dchain\": \"\",\n    \"done_at\": \"\",\n    \"fee\": \"\",\n    \"high_risk\": null,\n    \"status\": null,\n    \"tag\": null,\n    \"tx_id\": null,\n    \"tx_link\": null,\n    \"type\": \"\",\n    \"updated_at\": \"\",\n    \"uid\": \"\"\n}\n\n

Retrieve Deposits

This endpoint makes an HTTP GET request to retrieve a list of deposits.

Request

No request body is required for this request.

Response

The response for this request is a JSON object with the following parameters:

total_count (integer) - The total count of deposits.
\n
per_page (integer) - The number of deposits per page.
\n
total_pages (integer) - The total number of pages.
\n
page (integer) - The current page number.
\n
prev_page (integer or null) - The previous page number, or null if there is no previous page.
\n
next_page (integer or null) - The next page number, or null if there is no next page.
\n
items (array) - An array of deposit items with the following properties:
\n
- address (string) - The address of the deposit.
  \n
- amount (string) - The amount of the deposit.
  \n
- asset (string) - The asset of the deposit.
  \n
- control (object or null) - The control of the deposit, if applicable.
  \n
- created_at (string) - The creation date of the deposit.
  \n
- dchain_id (string) - The ID of the deposit chain.
  \n
- done_at (string) - The completion date of the deposit.
  \n
- fee (string) - The fee of the deposit.
  \n
- high_risk (boolean or null) - Indicates if the deposit is high risk, or null if not applicable.
  \n
- status (string) - The status of the deposit.
  \n
- tag (string or null) - The tag associated with the deposit, if available.
  \n
- tx_id (string) - The transaction ID of the deposit.
  \n
- tx_link (string) - The transaction link of the deposit.
  \n
- type (string) - The type of the deposit.
  \n
- updated_at (string) - The last update date of the deposit.
  \n
- uid (string) - The unique identifier of the deposit.
  \n
\n

Example response:

{\n    \"total_count\": 0,\n    \"per_page\": 0,\n    \"total_pages\": 0,\n    \"page\": 0,\n    \"prev_page\": null,\n    \"next_page\": null,\n    \"items\": [\n        {\n            \"address\": \"\",\n            \"amount\": \"\",\n            \"asset\": \"\",\n            \"control\": null,\n            \"created_at\": \"\",\n            \"dchain_id\": \"\",\n            \"done_at\": \"\",\n            \"fee\": \"\",\n            \"high_risk\": null,\n            \"status\": \"\",\n            \"tag\": null,\n            \"tx_id\": \"\",\n            \"tx_link\": \"\",\n            \"type\": \"\",\n            \"updated_at\": \"\",\n            \"uid\": \"\"\n        }\n    ]\n}\n\n

GET /api/v1/business/deposits/{{uid}}

This endpoint retrieves details of a specific deposit identified by the provided ID.

Request

No request body is required for this endpoint. The request should include the following headers:

Content-Type: application/json
\n
Authorization: Bearer token
\n

Response

The response will be a JSON object with the following properties:

address (string): The address associated with the deposit.
\n
amount (string): The amount of the deposit.
\n
asset (string): The type of asset for the deposit.
\n
control (null): Control information for the deposit.
\n
created_at (string): The timestamp when the deposit was created.
\n
dchain (string): The ID of the deposit chain.
\n
done_at (string): The timestamp when the deposit was completed.
\n
fee (string): The fee associated with the deposit.
\n
high_risk (null): Indicates if the deposit is considered high risk.
\n
status (string): The status of the deposit.
\n
tag (null): Tag information for the deposit.
\n
tx_id (string): The transaction ID associated with the deposit.
\n
tx_link (string): The link to the transaction details.
\n
type (string): The type of the deposit.
\n
updated_at (string): The timestamp when the deposit was last updated.
\n
uid (string): The UID of the deposit.
\n

This endpoint makes an HTTP GET request to retrieve the actions associated with a specific deposit identified by the unique user ID (uid).

Request

The request does not contain a request body. The endpoint URL includes the base URL followed by '/api/v1/business/deposits/' and the user ID (uid) parameter.

base_url: The base URL of the API.
\n
uid: The unique identifier of the user.
\n

Response

The response will include the details of the actions associated with the specified deposit, such as action IDs, timestamps, and other relevant information.

This endpoint is used to generate a token for a specific action associated with a deposit. The HTTP POST request should be made to https://my.kyrrex.mt/api/v1/business/deposits/:uid/actions/:action_id/generate_token.

Response

The response for this request is a JSON object with a \"token\" field. The \"token\" field is a string representing the generated token.

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"token\": {\n      \"type\": \"string\"\n    }\n  }\n}\n\n

Generate Web Link for Deposit Action

This endpoint allows you to generate a web link for a specific deposit action.

Request Body

level_name: (string) The name of the level.

Response

link: (string) The generated web link.

Example Response:

{\n    \"link\": \"example_generated_web_link\"\n}\n\n

This endpoint makes an HTTP GET request to retrieve deposit addresses from the specified base URL. The response includes the total count of deposit addresses, the number of addresses per page, total pages, current page number, previous and next page URLs, and an array of deposit address items.

The example response includes the following key details:

limit: 0
\n
total_count: 0
\n
per_page: 0
\n
total_pages: 0
\n
page: 0
\n
prev_page: null
\n
next_page: null
\n
items: An array containing deposit address items with keys such as address, asset, dchain, expired_at, name, tag, type, and uid.
\n

To enhance security, you can utilize saved data using variables and vault secrets for authentication and other sensitive information.

Create Deposit Address

This endpoint is used to create a deposit address.

Request Body

dchain (string, required): The type of blockchain for the deposit address.
\n
name (string, required): A custom name for the deposit address.
\n

Example Request Body:

{\n    \"dchain\": \"trx\",\n    \"name\": \"trx\"\n}\n\n

Response

Status: 201
\n
Content-Type: application/json
\n

Example Response Body:

{\n    \"address\": \"\",\n    \"asset\": \"\",\n    \"dchain\": \"\",\n    \"expired_at\": null,\n    \"name\": \"\",\n    \"tag\": null,\n    \"type\": \"\",\n    \"uid\": 0\n}\n\n

User authentication token

\n"},{"key":"APISign","value":"{{api_sign}}","description":"

Request signature

\n"},{"key":"APIKey","value":"{{api_key}}","description":"

Public API key

\n"}],"body":{"mode":"raw","raw":"{\n \"provider_id\": \"mmeur\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.mt/api/v1/business/fiat/{{provider_id}}/customers","description":"

Add Customer for Fiat Provider

This endpoint allows you to register a customer under a specific fiat provider.

Request Body

provider_id (string) - The ID of the fiat provider. Example: \"mmeur\"

Response

The response schema of this request is a JSON object with a 'status' property of type 'string'.

{\n    \"type\": \"object\",\n    \"properties\": {\n        \"status\": {\n            \"type\": \"string\"\n        }\n    }\n}\n\n

User authentication token

\n"},{"key":"APISign","value":"{{api_sign}}","description":"

Request signature

\n"},{"key":"APIKey","value":"{{api_key}}","description":"

Public API key

\n"}],"body":{"mode":"raw","raw":"{\n \"provider_id\": \"mmeur\",\n \"instrument\": \"sepa_tag\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.mt/api/v1/business/fiat/providers/{{provider_id}}/instruments/bank_transfers","description":"

Create Bank Transfer Instrument

This endpoint is used to register a bank transfer instrument for a specific provider.

Request Body

provider_id (string): The ID of the provider.
\n
instrument (string): The type of instrument, e.g., \"sepa_tag\".
\n

Response

Upon successful registration, the response will contain the details of the newly registered bank transfer instrument, including the status field indicating the status of the operation.

{\n    \"status\": \"true\"\n}\n\n

User authentication token

\n"},{"key":"APISign","value":"{{api_sign}}","description":"

Request signature

\n"},{"key":"APIKey","value":"{{api_key}}","description":"

Public API key

\n"}],"url":"https://my.kyrrex.mt/api/v1/business/fiat/providers/{{provider_id}}/customers","description":"

Retrieve Customer Registration Status

Retrieves the registration status of a customer for a specific provider.

Request

Method: GET
\n
URL: https://my.kyrrex.mt/api/v1/business/fiat/providers/{{provider_id}}/customers
\n
This request does not contain a request body.
\n

Response

The response for this request is documented as a JSON schema, including the following fields:

provider_id (string): The ID of the provider.
\n
status (string): The status of the customer registration.
\n
instruments (object): An object containing the following sub-fields:
\n
- card (object): An object containing the following sub-field:
  \n
  - state (string): The state of the card instrument.
  \n
- sepa (object): An object containing the following sub-field:
  \n
  - state (string): The state of the SEPA instrument.
  \n
- sepa_tag (object): An object containing the following sub-field:
  \n
  - state (string): The state of the SEPA tag instrument.
  \n
\n

User authentication token

\n"},{"key":"APISign","value":"{{api_sign}}","description":"

Request signature

\n"},{"key":"APIKey","value":"{{api_key}}","description":"

Public API key

\n"}],"url":"https://my.kyrrex.mt/api/v1/business/fiat/providers/withdrawals","description":"

GET /api/v1/business/fiat/providers/withdrawals

Description

This endpoint is used to retrieve a list of providers and instruments available for withdrawals.

Request

No request body is required for this GET request.

Response

total_count (integer): The total count of available providers and instruments.
\n
per_page (integer): The number of items per page.
\n
total_pages (integer): The total number of pages.
\n
page (integer): The current page number.
\n
prev_page (null or integer): The number of the previous page, if available.
\n
next_page (null or integer): The number of the next page, if available.
\n
items (array): An array of objects containing provider and instrument details.
\n
- id (string): The ID of the provider.
  \n
- name (string): The name of the provider.
  \n
- instruments (object): An object containing available withdrawal instruments.
  \n
  - bank_transfer (array): An array of available bank transfer options.
    \n
  - card (array): An array of available card withdrawal options.
    \n
  \n
\n

Example

{\n    \"total_count\": 0,\n    \"per_page\": 0,\n    \"total_pages\": 0,\n    \"page\": 0,\n    \"prev_page\": null,\n    \"next_page\": 0,\n    \"items\": [\n        {\n            \"id\": \"\",\n            \"name\": \"\",\n            \"instruments\": {\n                \"bank_transfer\": [\"\"],\n                \"card\": [\"\"]\n            }\n        }\n    ]\n}\n\n

User authentication token

\n"},{"key":"APISign","value":"{{api_sign}}","description":"

Request signature

\n"},{"key":"APIKey","value":"{{api_key}}","description":"

Public API key

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.mt/api/v1/business/fiat/providers/deposits","description":"

Get Fiat Deposit Providers

This endpoint is used to retrieve a list of providers and instruments for fiat deposits.

Request

Method: GET
\n
Base URL: https://my.kyrrex.mt/api/v1/business/fiat/providers/deposits
\n

Response

The response for this request is a JSON object containing an array of providers and their associated instruments. The response schema includes the following properties:

providers (array)
\n
- provider_id (string)
  \n
- name (string)
  \n
- instruments (array)
  \n
  - instrument_id (string)
    \n
  - name (string)
    \n
  \n
\n

An example response for this request is:

{\n  \"total_count\": 0,\n  \"per_page\": 0,\n  \"total_pages\": 0,\n  \"page\": 0,\n  \"prev_page\": null,\n  \"next_page\": 0,\n  \"items\": [\n    {\n      \"id\": \"\",\n      \"name\": \"\",\n      \"instruments\": {\n        \"bank_transfer\": [\"\"],\n        \"card\": [\"\"]\n      }\n    }\n  ]\n}\n\n

User authentication token

\n"},{"key":"APISign","value":"{{api_sign}}","description":"

Request signature

\n"},{"key":"APIKey","value":"{{api_key}}","description":"

Public API key

\n"}],"body":{"mode":"raw","raw":"{\n \"provider_id\": \"cheur\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.mt/api/v1/business/fiat/providers/:provider_id/instruments/cards","description":"

Create Fiat Card Instrument

This endpoint allows the creation of a fiat card instrument under a specific provider.

Request Body

provider_id (string, required): The ID of the provider for which the card instrument is being created.

Example:

{\n  \"provider_id\": \"cheur\"\n}\n\n

Response

The response for this request follows the below JSON schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"frame_url\": {\n      \"type\": \"string\"\n    },\n    \"request_id\": {\n      \"type\": \"string\"\n    },\n    \"status\": {\n      \"type\": \"string\"\n    }\n  }\n}\n\n

This endpoint allows the addition of a card instrument for a specific fiat provider.

Request Body

provider_id (string): The ID of the fiat provider. Example: \"cheur\"

Response

frame_url (string): The URL for the frame.
\n
request_id (string): The ID of the request.
\n
status (string): The status of the request.
\n

User authentication token

\n"},{"key":"APISign","value":"{{api_sign}}","description":"

Request signature

\n"},{"key":"APIKey","value":"{{api_key}}","description":"

Public API key

\n"}],"url":"https://my.kyrrex.mt/api/v1/business/fiat/providers/:provider_id/instruments/cards","description":"

Retrieve User's Cards

This endpoint retrieves the user's cards by making an HTTP GET request to https://my.kyrrex.mt/api/v1/business/fiat/providers/:provider_id/instruments/cards.

Request Body

This request does not require a request body.

Response Body

address (string): The address of the card.
\n
currency (string): The currency related to the card.
\n
expired_at (string, null): The expiration date of the card.
\n
fiat_details (object): Details related to fiat currency.
\n
name (string, null): The name of the card.
\n
tag (string, null): The tag associated with the card.
\n
type (string): The type of the card.
\n
uid (number): Unique identifier details.
\n

User authentication token

\n"},{"key":"APISign","value":"{{api_sign}}","description":"

Request signature

\n"},{"key":"APIKey","value":"{{api_key}}","description":"

Public API key

\n"}],"url":"https://my.kyrrex.mt/api/v1/business/fiat/withdrawals/fees?instrument=card&provider_id=cheur","description":"

Fetch Withdrawal Commission Fee

This endpoint makes an HTTP GET request to https://my.kyrrex.mt/api/v1/business/fiat/withdrawals/fees to fetch the withdrawal commission fee. The request includes the following query parameters:

instrument: Specifies the instrument for which the withdrawal fee is being fetched.
\n
provider_id: Represents the ID of the provider for which the withdrawal fee is being fetched.
\n

The response will include the withdrawal commission fee information.

Response

{\n    \"type\": \"object\",\n    \"properties\": {\n        \"dynamic\": {\n            \"type\": \"string\"\n        },\n        \"static\": {\n            \"type\": \"string\"\n        },\n        \"min_amount\": {\n            \"type\": \"string\"\n        }\n    }\n}\n\n

User authentication token

\n"},{"key":"APISign","value":"{{api_sign}}","description":"

Request signature

\n"},{"key":"APIKey","value":"{{api_key}}","description":"

Public API key

\n"}],"url":"https://my.kyrrex.mt/api/v1/business/fiat/providers/fees/withdrawals/estimate?instrument=card&amount=10.00&provider_id=cheur","description":"

Get Withdrawal Fee Estimate

This endpoint retrieves an estimate of the withdrawal fee for a specified instrument and amount.

Request Parameters

instrument (string): Specifies the instrument for withdrawal.
\n
amount (number): Specifies the withdrawal amount.
\n
provider_id (string): Identifies the provider for the withdrawal.
\n

Response

The response will include the following fields:

amount (string): The withdrawal amount.
\n
fee (string): The withdrawal fee.
\n
total_amount (string): The total amount after deducting the fee.
\n

Example response:

{\n    \"amount\": \"\",\n    \"fee\": \"\",\n    \"total_amount\": \"\"\n}\n\n

User authentication token

\n"},{"key":"APISign","value":"{{api_sign}}","description":"

Request signature

\n"},{"key":"APIKey","value":"{{api_key}}","description":"

Public API key

\n"}],"body":{"mode":"raw","raw":"{\n \"payout_method\": \"card\",\n \"instrument\": \"card\",\n \"provider_id\": \"cheur\",\n \"amount\": 10.00,\n \"currency\": \"EUR\",\n \"withdrawal_address_uid\": 6822\n}","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.mt/api/v1/business/fiat/withdrawals","description":"

Fiat Withdrawal Request

This POST request is used to withdraw fiat to a card or bank account. The request should be sent to https://my.kyrrex.mt/api/v1/business/fiat/withdrawals with the following payload in the raw request body type:

{\n  \"payout_method\": \"card\",\n  \"instrument\": \"card\",\n  \"provider_id\": \"cheur\",\n  \"amount\": 10,\n  \"currency\": \"EUR\",\n  \"withdrawal_address_uid\": 6822\n}\n\n

Examples

payout_method: card
\n
instrument: card
\n
provider_id: cheur
\n
amount: 10
\n
currency: EUR
\n
withdrawal_address_uid: 6822
\n

Response

The response will contain the following fields based on the payout method:

Cards

uid: Unique transaction identifier
\n
amount: Transaction amount
\n
currency: Transaction currency
\n
status: Transaction status
\n
fee: Transaction fee
\n
address: Card address
\n

Bank Transfer

uid: Unique transaction identifier
\n
amount: Transaction amount
\n
currency: Transaction currency
\n
status: Transaction status
\n
fee: Transaction fee
\n
address: Bank account address
\n

User authentication token

\n"},{"key":"APISign","value":"{{api_sign}}","description":"

Request signature

\n"},{"key":"APIKey","value":"{{api_key}}","description":"

Public API key

\n"}],"url":"https://my.kyrrex.mt/api/v1/business/fiat/withdrawals?provider_id=cheur¤cy=eur&status=done","description":"

Retrieve Fiat Withdrawals

Returns a list of withdrawal transactions.

Request

Method: GET
\n
URL: https://my.kyrrex.mt/api/v1/business/fiat/withdrawals
\n
Query Parameters:
\n
- provider_id: cheur
  \n
- currency: eur
  \n
- status: done
  \n
\n

Response

The response schema for this request is as follows:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"total_count\": {\n      \"type\": \"integer\"\n    },\n    \"per_page\": {\n      \"type\": \"integer\"\n    },\n    \"total_pages\": {\n      \"type\": \"integer\"\n    },\n    \"page\": {\n      \"type\": \"integer\"\n    },\n    \"prev_page\": {\n      \"type\": \"integer\"\n    },\n    \"next_page\": {\n      \"type\": \"integer\"\n    },\n    \"items\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"address\": {\n            \"type\": \"string\"\n          },\n          \"amount\": {\n            \"type\": \"number\"\n          },\n          \"currency\": {\n            \"type\": \"string\"\n          },\n          \"created_at\": {\n            \"type\": \"string\",\n            \"format\": \"date-time\"\n          },\n          \"provider_id\": {\n            \"type\": \"string\"\n          },\n          \"done_at\": {\n            \"type\": \"string\",\n            \"format\": \"date-time\"\n          },\n          \"fee\": {\n            \"type\": \"number\"\n          },\n          \"recipient\": {\n            \"type\": \"string\"\n          },\n          \"sender\": {\n            \"type\": \"string\"\n          },\n          \"status\": {\n            \"type\": \"string\"\n          },\n          \"tag\": {\n            \"type\": \"string\"\n          },\n          \"updated_at\": {\n            \"type\": \"string\",\n            \"format\": \"date-time\"\n          },\n          \"uid\": {\n            \"type\": \"string\"\n          }\n        }\n      }\n    }\n  }\n}\n\n

Get Fiat Currencies

This endpoint retrieves a list of fiat currencies with active deposit and withdrawal options.

Request

Method: GET
\n
URL: https://my.kyrrex.mt/api/v1/business/fiat/currencies
\n
Query Parameters:
\n
- active_deposit (boolean, required): Indicates if the currency is active for deposit.
  \n
- active_withdrawal (boolean, required): Indicates if the currency is active for withdrawal.
  \n
\n

Response

The response will include an array of items, each containing the following properties:

total_count (number): Total count of currencies
\n
per_page (number): Currencies per page
\n
total_pages (number): Total pages
\n
page (number): Current page
\n
prev_page (string): Link to the previous page
\n
next_page (string): Link to the next page
\n
items (array): Array of currencies, each containing the following properties:
\n
- currency (string): Currency code
  \n
- providers (array): Array of providers for the currency, each containing the following properties:
  \n
  - active_deposit (boolean): Indicates if the provider is active for deposit
    \n
  - active_withdrawal (boolean): Indicates if the provider is active for withdrawal
    \n
  - currency (string): Currency code
    \n
  - provider_id (string): Provider ID
    \n
  - digit (number): Digit precision
    \n
  - display_name (string): Display name
    \n
  \n
- name (string): Currency name
  \n
- precision (number): Precision of the currency
  \n
\n

Example Response:

{\n    \"total_count\": 0,\n    \"per_page\": 0,\n    \"total_pages\": 0,\n    \"page\": 0,\n    \"prev_page\": null,\n    \"next_page\": null,\n    \"items\": [\n        {\n            \"currency\": \"\",\n            \"providers\": [\n                {\n                    \"active_deposit\": true,\n                    \"active_withdrawal\": true,\n                    \"currency\": \"\",\n                    \"provider_id\": \"\",\n                    \"digit\": 0,\n                    \"display_name\": \"\"\n                }\n            ],\n            \"name\": \"\",\n            \"precision\": 0\n        }\n    ]\n}\n\n

Get Business Exchange Fees Estimate

This endpoint retrieves the estimated fees for exchanging fiat currency to cryptocurrency and withdraw to the client wallet.

Request Parameters

instrument (required): The trading pair symbol or instrument for the exchange.
\n
provider_id (required): The ID of the exchange provider.
\n
fiat_amount (required): The amount in the fiat currency for the exchange.
\n
crypto_amount (required): The amount in the cryptocurrency for the exchange.
\n

Response

The response will include the following fields:

input_amount: The input amount for the exchange.
\n
input_currency: The currency of the input amount.
\n
fee: The estimated fee for the exchange.
\n
fee_currency: The currency of the fee.
\n
output_amount: The output amount after deducting the fee.
\n
output_asset: The asset or currency of the output amount.
\n

required

\n","type":"text/plain"},"key":"instrument","value":"card"},{"description":{"content":"

required

\n","type":"text/plain"},"key":"provider_id","value":"cheur"},{"description":{"content":"

required

\n","type":"text/plain"},"key":"fiat_amount","value":"100"},{"description":{"content":"

required

\n","type":"text/plain"},"key":"crypto_amount","value":"10"}],"variable":[]}},"response":[{"id":"9d3bcfe7-a258-405a-86f3-5a57ffa675cb","name":"fees estimate","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.mt/api/v1/business/advanced_exchange/estimate?instrument=card&provider_id=cheur&fiat_amount=100&crypto_amount=10","host":["https://my.kyrrex.mt"],"path":["api","v1","business","advanced_exchange","estimate"],"query":[{"key":"instrument","value":"card","description":"required"},{"key":"provider_id","value":"cheur","description":"required"},{"key":"fiat_amount","value":"100","description":"required"},{"key":"crypto_amount","value":"10","description":"required"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"input_amount\": \"100\",\n \"input_currency\": \"eur\",\n \"fee\": \"10\",\n \"fee_currency\": \"eur\",\n \"output_amount\": \"90\",\n \"output_asset\": \"usdc\"\n}"}],"_postman_id":"c18fff9c-a712-4f9f-806c-a4153e1961f6"},{"name":"exchange","id":"0861965f-18ac-42a5-b8ae-ccf72ac35f18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"deposit_address_uid\": 7754, //fiat address deposit (instrument uid)\r\n \"fiat_currency\": \"EUR\",\r\n \"crypto_asset\": \"BTC\",\r\n \"fiat_amount\": 100,\r\n \"payment_method\": \"card\",\r\n \"provider_id\": \"cheur\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.mt/api/v1/business/advanced_exchanges","description":"

API Request Description

This endpoint allows you to perform an advanced exchange for a business. The request should be sent via an HTTP POST method to https://my.kyrrex.mt/api/v1/business/advanced_exchanges.

Request Body

deposit_address_uid (number): The unique identifier for the fiat deposit address (instrument uid).
\n
fiat_currency (string): The fiat currency for the exchange.
\n
crypto_asset (string): The cryptocurrency asset for the exchange.
\n
fiat_amount (number): The amount in fiat currency for the exchange.
\n
payment_method (string): The payment method for the exchange.
\n
provider_id (string): The ID of the provider for the exchange.
\n

Response

The response will be in JSON format and may include the following fields:

frame_url (string): The URL for the exchange frame.
\n
uid (string): The unique identifier for the exchange.
\n

JSON Schema for Response

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"frame_url\": {\n      \"type\": \"string\"\n    },\n    \"uid\": {\n      \"type\": \"string\"\n    }\n  }\n}\n\n

GET /api/v1/business/advanced_exchanges

This endpoint retrieves a list of advanced exchanges with the specified status and sorted by creation date.

Request

Parameters:
\n
- status (query parameter, required): The status of the advanced exchanges to filter by.
  \n
- sort_by (query parameter, required): The field to sort the advanced exchanges by.
  \n
\n

Response

The response for this request follows the JSON schema below:

{\n    \"type\": \"object\",\n    \"properties\": {\n        \"total_count\": {\n            \"type\": \"integer\"\n        },\n        \"per_page\": {\n            \"type\": \"integer\"\n        },\n        \"total_pages\": {\n            \"type\": \"integer\"\n        },\n        \"page\": {\n            \"type\": \"integer\"\n        },\n        \"prev_page\": {\n            \"type\": [\"integer\", \"null\"]\n        },\n        \"next_page\": {\n            \"type\": [\"integer\", \"null\"]\n        },\n        \"items\": {\n            \"type\": \"array\",\n            \"items\": {\n                \"type\": \"object\",\n                \"properties\": {\n                    \"uid\": {\n                        \"type\": \"string\"\n                    },\n                    \"fiat_currency\": {\n                        \"type\": \"string\"\n                    },\n                    \"crypto_asset\": {\n                        \"type\": \"string\"\n                    },\n                    \"input_amount\": {\n                        \"type\": \"number\"\n                    },\n                    \"output_amount\": {\n                        \"type\": \"number\"\n                    },\n                    \"status\": {\n                        \"type\": \"string\"\n                    },\n                    \"created_at\": {\n                        \"type\": \"string\"\n                    },\n                    \"updated_at\": {\n                        \"type\": \"string\"\n                    }\n                }\n            }\n        }\n    }\n}\n\n

allowed values - created_at

\n","type":"text/plain"},"key":"sort_by","value":"created_at"}],"variable":[]}},"response":[{"id":"163b1b95-f0cd-4ce4-abc4-ff4508fae4e6","name":"list","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.mt/api/v1/business/advanced_exchanges?status=completed&sort_by=created_at","host":["https://my.kyrrex.mt"],"path":["api","v1","business","advanced_exchanges"],"query":[{"key":"status","value":"completed"},{"key":"sort_by","value":"created_at","description":"allowed values - created_at"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 1,\n \"per_page\": 1,\n \"total_pages\": 1,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": 2,\n \"items\": [\n {\n \"uid\": \"230-567216545007490\",\n \"fiat_currency\": \"eur\",\n \"crypto_asset\": \"trx\",\n \"input_amount\": 15,\n \"output_amount\": 72,\n \"status\": \"done\",\n \"created_at\": \"2025-03-20T12:14:21.920Z\",\n \"updated_at\": \"2025-04-20T12:14:21.920Z\"\n }\n ]\n}"}],"_postman_id":"e9c41034-278b-42dc-82c6-0412819b74f0"}],"id":"853191e6-b2ff-452d-8d2f-f9b3e7bddcbf","_postman_id":"853191e6-b2ff-452d-8d2f-f9b3e7bddcbf","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","name":"Kyrrex Malta on/off-ramp","type":"collection"}}},{"name":"orders","item":[{"name":"list","id":"5f93c183-c53b-4b89-aa2a-578f19062625","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v1/business/orders?market&from&to&asset&state&side&ord_type&price_min&price_max&sort&sort_by&page&per_page","description":"

Retrieve Business Orders

This endpoint retrieves business orders based on the specified filters.

Request Parameters

market (optional): Filter by market.
\n
from (optional): Filter orders created after this timestamp.
\n
to (optional): Filter orders created before this timestamp.
\n
asset (optional): Filter by asset.
\n
state (optional): Filter by order state.
\n
side (optional): Filter by order side.
\n
ord_type (optional): Filter by order type.
\n
price_min (optional): Filter by minimum price.
\n
price_max (optional): Filter by maximum price.
\n
sort (optional): Sort order (e.g., asc, desc).
\n
sort_by (optional): Sort by field.
\n
page (optional): Page number for pagination.
\n
per_page (optional): Number of items per page.
\n

Response

The response will include the following fields:

prices: Object containing buy and sell prices.
\n
- sell: Array of sell prices.
  \n
- buy: Array of buy prices.
  \n
\n
order: Order information.
\n
total_count: Total count of orders.
\n
per_page: Number of items per page.
\n
total_pages: Total number of pages.
\n
page: Current page number.
\n
next_page: Next page number.
\n
items: Array of order items, each containing the following fields:
\n
- created_at: Order creation timestamp.
  \n
- executed_volume: Executed order volume.
  \n
- fulfillment: Order fulfillment status.
  \n
- id: Order ID.
  \n
- market_id: Market ID.
  \n
- ord_type: Order type.
  \n
- price: Order price.
  \n
- remaining_volume: Remaining order volume.
  \n
- side: Order side.
  \n
- state: Order state.
  \n
- trades_count: Number of trades.
  \n
- volume: Order volume.
  \n
\n

optional

\n","type":"text/plain"},"key":"market","value":null},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"from","value":null},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"to","value":null},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"asset","value":null},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"state","value":null},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"side","value":null},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"ord_type","value":null},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"price_min","value":null},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"price_max","value":null},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"

optional (fulfillment created_at volume)

\n","type":"text/plain"},"key":"sort_by","value":null},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"page","value":null},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"per_page","value":null}],"variable":[]}},"response":[{"id":"ed247189-3a25-4165-8b94-1ac78387b581","name":"list","originalRequest":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v1/business/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"prices\": {\r\n\t\t\"sell\": [],\r\n\t\t\"buy\": [\"1000.0\", \"10000.0\", \"26948.7\"]\r\n\t},\r\n\t\"order\": \" \",\r\n\t\"total_count\": 7,\r\n\t\"per_page\": 2,\r\n\t\"total_pages\": 4,\r\n\t\"page\": 1,\r\n\t\"prev_page\": nil,\r\n\t\"next_page\": 2,\r\n\t\"items\": [\r\n\t\t{\r\n\t\t\t\"avg_price\": nil,\r\n\t\t\t\"created_at\": \"2022-08-22T09:16:50.941Z\",\r\n\t\t\t\"executed_volume\": \"0.0\",\r\n\t\t\t\"fulfillment\": \"0.0\",\r\n\t\t\t\"id\": 682,\r\n\t\t\t\"market_id\": \"btcusdt\",\r\n\t\t\t\"ord_type\": \"limit\",\r\n\t\t\t\"price\": \"1000.0\",\r\n\t\t\t\"remaining_volume\": \"0.01\",\r\n\t\t\t\"side\": \"buy\",\r\n\t\t\t\"state\": \"wait\",\r\n\t\t\t\"trades_count\": 0,\r\n\t\t\t\"volume\": \"0.01\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"avg_price\": nil,\r\n\t\t\t\"created_at\": \"2022-08-26T09:36:56.629Z\",\r\n\t\t\t\"executed_volume\": \"0.0024\",\r\n\t\t\t\"fulfillment\": \"0.24\",\r\n\t\t\t\"id\": 737,\r\n\t\t\t\"market_id\": \"btcusdt\",\r\n\t\t\t\"ord_type\": \"limit\",\r\n\t\t\t\"price\": \"1000.0\",\r\n\t\t\t\"remaining_volume\": \"0.0076\",\r\n\t\t\t\"side\": \"buy\",\r\n\t\t\t\"state\": \"wait\",\r\n\t\t\t\"trades_count\": 5,\r\n\t\t\t\"volume\": \"0.01\"\r\n\t\t}\r\n\t]\r\n}"}],"_postman_id":"5f93c183-c53b-4b89-aa2a-578f19062625"},{"name":"info","id":"b4b53603-3bc1-438e-bf9a-758612936efa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v1/business/orders/:id","description":"

This endpoint retrieves the details of a specific order by providing the order ID in the URL. The request does not require a request body. The response will include details such as average price, creation timestamp, executed volume, fulfillment status, order type, price, remaining volume, side, state, trade count, and volume. Note that some of these details may be null or empty based on the specific order.

Create Order

This endpoint allows you to create a new order.

Request Body

volume (string) - The volume of the order.
\n
market (string) - The market for the order.
\n
side (string) - The side of the order (buy/sell).
\n
ord_type (string) - The type of order (limit/market).
\n
price (string) - The price of the order.
\n

Example:

{\n  \"volume\": \"0.01\",\n  \"market\": \"btcusdt\",\n  \"side\": \"buy\",\n  \"ord_type\": \"limit\",\n  \"price\": 1000\n}\n\n

Response

avg_price (string) - The average price of the order.
\n
created_at (string) - The timestamp of order creation.
\n
executed_volume (string) - The volume of the order that has been executed.
\n
fulfillment (string) - The fulfillment status of the order.
\n
id (integer) - The ID of the order.
\n
market_id (string) - The ID of the market.
\n
ord_type (string) - The type of order.
\n
price (string) - The price of the order.
\n
remaining_volume (string) - The remaining volume of the order.
\n
side (string) - The side of the order.
\n
state (string) - The state of the order.
\n
trades_count (integer) - The count of trades associated with the order.
\n
volume (string) - The volume of the order.
\n

Example:

{\n  \"avg_price\": null,\n  \"created_at\": \"\",\n  \"executed_volume\": \"\",\n  \"fulfillment\": \"\",\n  \"id\": 0,\n  \"market_id\": \"\",\n  \"ord_type\": \"\",\n  \"price\": \"\",\n  \"remaining_volume\": \"\",\n  \"side\": \"\",\n  \"state\": \"\",\n  \"trades_count\": 0,\n  \"volume\": \"\"\n}\n\n

This endpoint sends an HTTP DELETE request to delete a specific order with the provided ID.

Request Body

This request does not require a request body.

Response

status (boolean): Indicates whether the deletion was successful. A value of true indicates success.

Delete Orders

This endpoint is used to delete orders.

Request Body
This request does not require a request body.

Response

status (boolean): Indicates the status of the request. A value of true indicates a successful deletion.

Example Response

{\n    \"status\": true\n}\n\n

Retrieve Markets

This endpoint makes an HTTP GET request to retrieve a list of markets.

Request

No request body is required for this endpoint.

base_url (string, required): The base URL for the API.

Response

The response for this request can be represented as a JSON schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"total_count\": {\n      \"type\": \"integer\"\n    },\n    \"per_page\": {\n      \"type\": \"integer\"\n    },\n    \"total_pages\": {\n      \"type\": \"integer\"\n    },\n    \"page\": {\n      \"type\": \"integer\"\n    },\n    \"next_page\": {\n      \"type\": \"integer\"\n    },\n    \"items\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"active\": {\n            \"type\": \"boolean\"\n          },\n          \"available_quote_balance\": {\n            \"type\": \"string\"\n          },\n          \"base_asset\": {\n            \"type\": \"string\"\n          },\n          \"base_precision\": {\n            \"type\": \"integer\"\n          },\n          \"id\": {\n            \"type\": \"string\"\n          },\n          \"market\": {\n            \"type\": \"string\"\n          },\n          \"name\": {\n            \"type\": \"string\"\n          },\n          \"quote_asset\": {\n            \"type\": \"string\"\n          },\n          \"quote_precision\": {\n            \"type\": \"integer\"\n          }\n        }\n      }\n    }\n  }\n}\n\n

The endpoint retrieves information about a specific market using an HTTP GET request to https://my.kyrrex.mt/api/v1/business/markets/:market. The response for this request can be documented as a JSON schema as follows:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"active\": {\n      \"type\": \"boolean\"\n    },\n    \"available_quote_balance\": {\n      \"type\": \"string\"\n    },\n    \"base_asset\": {\n      \"type\": \"string\"\n    },\n    \"base_asset_tag\": {\n      \"type\": \"string\"\n    },\n    \"base_precision\": {\n      \"type\": \"integer\"\n    },\n    \"id\": {\n      \"type\": \"string\"\n    },\n    \"market\": {\n      \"type\": \"string\"\n    },\n    \"name\": {\n      \"type\": \"string\"\n    },\n    \"quote_asset\": {\n      \"type\": \"string\"\n    },\n    \"quote_asset_tag\": {\n      \"type\": \"string\"\n    },\n    \"quote_precision\": {\n      \"type\": \"integer\"\n    }\n  }\n}\n\n

required

\n","type":"text/plain"},"type":"any","value":"","key":"market"}]}},"response":[{"id":"91a2b27c-071f-4f58-8dfc-8b40f4263b61","name":"info","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.mt/api/v1/business/markets/:market","host":["https://my.kyrrex.mt"],"path":["api","v1","business","markets",":market"],"variable":[{"key":"market","value":"","description":"required"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"active\": true,\r\n\t\"available_quote_balance\": \"0.9\",\r\n\t\"base_asset\": \"trx\",\r\n\t\"base_asset_tag\": \"\",\r\n\t\"base_precision\": 8,\r\n\t\"id\": \"trxeur\",\r\n\t\"market\": \"trxeur\",\r\n\t\"name\": \"TRX/EUR\",\r\n\t\"quote_asset\": \"eur\",\r\n\t\"quote_asset_tag\": \"\",\r\n\t\"quote_precision\": 6\r\n}"}],"_postman_id":"6a44f3f1-b594-4885-843e-591cdf30a9df"}],"id":"e060dc1f-f338-4d49-86b3-eb7c6a416df1","_postman_id":"e060dc1f-f338-4d49-86b3-eb7c6a416df1","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","name":"Kyrrex Malta on/off-ramp","type":"collection"}}},{"name":"webhooks","item":[],"id":"1aede37d-3699-4db8-aa36-565482d9faaa","description":"

Webhooks Documentation

Overview

Webhooks allow you to receive real-time notifications from our platform when important events occur, such as user verification, deposits, withdrawals, and trades.

Each webhook request will be sent as a POST request with a JSON body to your configured URL.

All payloads have two main fields:

type — event type identifier
\n
data — detailed event information
\n

Webhook Event Types

1. Member Verification

Event type: kyc_verified

Triggered when a user's KYC verification is successfully completed.

Example payload:

jsonCopyEdit{\n  \"type\": \"kyc_verified\",\n  \"data\": {\n    \"member\": {\n      \"uid\": \"mtz12d12\",\n      \"email\": \"test_user+1@kyrrex.com\",\n      \"verified\": true\n    }\n  }\n}\n\n

Fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
uid	string	Unique user identifier
email	string	User's email address
verified	boolean	Verification status (always true)

2. Deposit

Event type: deposit

Triggered when a deposit event occurs.

Example payload:

jsonCopyEdit{\n  \"type\": \"deposit\",\n  \"data\": {\n    \"address\": \"0x8a021C1452fAe8DD7D7e10e8eCA1790B54CA8922\",\n    \"amount\": \"10.6\",\n    \"asset\": \"usdc\",\n    \"asset_type\": \"crypto\",\n    \"control\": null,\n    \"created_at\": \"2025-01-08T09:56:48.705Z\",\n    \"dchain\": \"usdc\",\n    \"done_at\": \"2025-04-02T15:57:35.850Z\",\n    \"fee\": \"0.0\",\n    \"high_risk\": null,\n    \"status\": \"processing\",\n    \"tag\": null,\n    \"tx_id\": null,\n    \"tx_link\": null,\n    \"type\": \"deposit\",\n    \"updated_at\": \"2025-04-02T15:57:35.850Z\",\n    \"uid\": \"654-36\"\n  }\n}\n\n

Possible status values:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Description
created	Deposit created
aml_processing	Awaiting AML check
processing	Processing via blockchain
frozen	Frozen due to failed AML
done	Deposit completed successfully
rejected	Deposit rejected and returned to client

3. Order

Event type: order

Triggered when a swap or order event occurs.

Example payload:

jsonCopyEdit{\n  \"type\": \"order\",\n  \"data\": {\n    \"amount\": \"50.0\",\n    \"created_at\": \"2025-04-07T12:30:29.545Z\",\n    \"currency\": \"usdceur\",\n    \"executed\": \"1.0\",\n    \"input_currency\": \"usdc\",\n    \"output_amount\": \"44.29\",\n    \"output_currency\": \"eur\",\n    \"state\": \"done\",\n    \"uid\": \"230-567216589555544\"\n  }\n}\n\n

Possible state values:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

State	Description
fail	Order failed (e.g. small amount)
wait	Order is being processed
done	Order completed successfully
cancel	Order was cancelled

4. Withdrawal

Event type: withdraw

Triggered when a withdrawal event occurs.

Example payload:

jsonCopyEdit{\n  \"type\": \"withdraw\",\n  \"data\": {\n    \"address\": \"0x8a021C1452fAe8DD7D7e10e8eCA1790B54CA8922\",\n    \"amount\": \"10.6\",\n    \"asset\": \"usdc\",\n    \"asset_type\": \"crypto\",\n    \"control\": null,\n    \"created_at\": \"2025-01-08T09:56:48.705Z\",\n    \"dchain\": \"usdc\",\n    \"done_at\": \"2025-04-02T15:57:35.850Z\",\n    \"fee\": \"0.0\",\n    \"high_risk\": null,\n    \"status\": \"processing\",\n    \"tag\": null,\n    \"tx_id\": null,\n    \"tx_link\": null,\n    \"type\": \"withdrawal\",\n    \"updated_at\": \"2025-04-02T15:57:35.850Z\",\n    \"uid\": \"654-36\"\n  }\n}\n\n

Possible status values:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Description
initiated	Funds are blocked on the client account
aml_processing	Awaiting AML (Anti-Money Laundering) check
processing	Withdrawal process initiated (blockchain interaction)
done	Withdrawal completed successfully
rejected	Withdrawal rejected and funds returned
postponed	Blockchain transaction creation failed (e.g., node not responding)

5. Trade

Event type: trade

Triggered when a spot trade is executed.

Example payload:

jsonCopyEdit{\n  \"type\": \"trade\",\n  \"data\": {\n    \"created_at\": \"2025-04-07T12:38:41Z\",\n    \"fee\": \"0.07\",\n    \"fee_asset\": \"eur\",\n    \"funds\": \"30.95265\",\n    \"funds_asset\": \"eur\",\n    \"id\": 842846,\n    \"in_asset\": \"eur\",\n    \"market\": \"trxeur\",\n    \"order_id\": 20193909,\n    \"out_asset\": \"trx\",\n    \"price\": \"0.206351\",\n    \"side\": \"sell\",\n    \"type\": \"sell\",\n    \"volume\": \"150.0\",\n    \"volume_asset\": \"trx\"\n  }\n}\n\n

Fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
created_at	string	Timestamp of the trade
fee	string	Fee amount
fee_asset	string	Asset in which fee was charged
funds	string	Total funds spent
funds_asset	string	Asset of the spent funds
id	integer	Trade ID
in_asset	string	Asset given by user
market	string	Market pair (e.g., trxeur)
order_id	integer	Associated order ID
out_asset	string	Asset received
price	string	Price per unit
side	string	\"buy\" or \"sell\"
type	string	Always matches the `side` field
volume	string	Volume of the traded asset
volume_asset	string	Asset of the traded volume

General Notes

Delivery method: Webhooks are sent as HTTP POST requests with Content-Type: application/json.
\n
Retries: If your endpoint fails to respond with HTTP 200, we will retry sending the webhook multiple times with backoff strategy.
\n
Security recommendation: Use secret headers or IP whitelisting to validate webhook origins.
\n

\n","_postman_id":"1aede37d-3699-4db8-aa36-565482d9faaa","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","id":"1ec0a151-cb85-4368-bde8-c7c30893a6da","name":"Kyrrex Malta on/off-ramp","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]}},"event":[{"listen":"prerequest","script":{"id":"bd37590d-0256-40c9-bf45-284e0c564743","type":"text/javascript","packages":{},"exec":["const secretKey = pm.collectionVariables.get(\"secret_key\");","const method = pm.request.method;","const endpoint = pm.request.url.getPath();","let dataToSign;","","function objectToQueryString(obj) {"," const flatObject = flattenObject(obj);"," const sortedKeys = Object.keys(flatObject).sort();"," const queryParams = sortedKeys.map(key => `${encodeURIComponent(key)}=${encodeURIComponent(flatObject[key])}`);"," return queryParams.join('&');","}","","function flattenObject(obj, parentKey = '', res = {}) {"," for (let key in obj) {"," const propName = parentKey ? parentKey + '_' + key : key;"," if (typeof obj[key] === 'object' && obj[key] !== null && !Array.isArray(obj[key]))"," flattenObject(obj[key], propName, res);"," else"," res[propName] = obj[key];"," }"," return res;","}","","if (method === \"GET\") {"," const queryObj = {};"," "," pm.request.url.query.all().forEach(param => {"," if (param.disabled !== true && param.key !== 'access_key' && param.key !== 'nonce') {"," const key = param.key.replace(/\\[\\]$/, '');"," "," if (queryObj[key] === undefined) {"," queryObj[key] = param.value;"," } else if (Array.isArray(queryObj[key])) {"," queryObj[key].push(param.value);"," } else {"," queryObj[key] = [queryObj[key], param.value];"," }"," }"," });"," "," const sortedKeys = Object.keys(queryObj).sort();"," "," dataToSign = sortedKeys.map(key => {"," if (key !== 'access_key' && key !== 'nonce') {"," const value = queryObj[key];"," const valueStr = Array.isArray(value) ? value.join(',') : value;"," return `${encodeURIComponent(key)}=${encodeURIComponent(valueStr)}`;"," }"," return '';"," }).filter(item => item !== '').join('&');"," ","} else if ([\"POST\", \"PUT\", \"PATCH\", \"DELETE\"].includes(method)) {"," const requestBody = JSON.parse(pm.request.body.raw || '{}');"," dataToSign = objectToQueryString(requestBody);","}","","const message = `${method}|${endpoint}|${dataToSign}`;","const signature = CryptoJS.HmacSHA256(message, secretKey).toString(CryptoJS.enc.Hex);","pm.collectionVariables.set(\"signature\", signature);","console.log(\"String to sign: \" + message);"]}},{"listen":"test","script":{"id":"d541e7b6-1ad4-4626-8245-fecd5a43a729","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"base_url","value":"https://my.kyrrex.mt"},{"key":"access_key","value":"","type":"string"},{"key":"secret_key","value":"","type":"string"},{"key":"signature","value":""},{"key":"auth_token","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb","type":"string"},{"key":"master_access_key","value":"","type":"string"},{"key":"master_secret_key","value":"","type":"string"},{"key":"master_signature","value":"","type":"string"}]}