{"info":{"_postman_id":"30cf573a-c182-40d5-a0c9-80d82e637d57","name":"Kyrrex Malta Business","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.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"42711896","collectionId":"30cf573a-c182-40d5-a0c9-80d82e637d57","publishedId":"2sAYdinpUc","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-04-01T11:04:41.000Z"},"item":[{"name":"Getting Started","item":[{"name":"Authentication & Request Signing","item":[],"id":"46365601-66d3-4082-8107-fa1eea732f07","description":"

Authentication in the Kyrrex Business API follows a strict three-stage security model, ensuring full separation between:

Business-level privileged operations
\n
Initial member registration
\n
Operational session keys used for all API actions
\n

This model prevents unauthorized access, enforces cryptographic validation, and ensures that only session-bound keys can perform financial operations.

1. Authentication Flow Overview

The complete lifecycle of keys works as follows:

Step 1 — Owner-Level Authorization (Auth-Token)

This token is provided to your business account by Kyrrex.

It is used only for registration flows:

creating a new member (/members/sign-up)
\n
performing administrative actions that do not involve balances or operations
\n

Step 2 — Registration → Initial access_key / secret_key

After member registration (/members/sign-up), the response contains:

access_key (public)
\n
secret_key (private)
\n

These keys cannot be used for operational endpoints yet.

They are used exclusively for:

\n\n

POST /api/v1/business/sessions\n\n

This is a mandatory step.

Step 3 — Session Keys (Operational keys)

After a successful login, the system returns a new pair of access_key + secret_key, tied to an active session.

These are the ONLY keys that can be used for:

deposits
\n
withdrawals
\n
crypto operations
\n
requisites
\n
assets
\n
markets
\n
swaps
\n
exchange
\n
everything else except registration
\n

Every operational request MUST use the session keys.

Session keys have an expiration timestamp and must be refreshed via the same login endpoint.

2. Required Headers

Every operational request requires:

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

Header	Description
APIKey	Session-level access_key
APISign	Signature generated using the session-level secret_key
Auth-Token	Only required for privileged registration operations

3. Request Signing Rules

The signature must be generated using this pattern:

{HTTP_METHOD}|{ENDPOINT_PATH}|{SORTED_PARAMETERS}\n\n

Where:

HTTP_METHOD - Uppercase method: GET, POST, PUT, DELETE.

ENDPOINT_PATH - Path only, without domain, e.g.:

/api/v1/business/withdrawals\n\n

SORTED_PARAMETERS - Exactly as script requires:

GET requests

include all enabled query parameters
\n
exclude:
\n
- access_key
  \n
- nonce
  \n
\n
flatten arrays → key=value1,value2
\n
sort keys alphabetically
\n
URL encode each key and value
\n

POST / PUT / PATCH / DELETE

parse JSON body
\n
flatten nested fields using underscore notation:
\n

{ \"user\": { \"email\": \"x\", \"id\": 10 } }\n\n

Becomes:

user_email=x&user_id=10\n\n

sort alphabetically
\n
encode via encodeURIComponent
\n
build key=value pairs
\n

4. Signature Generation

The final message is:

METHOD|/path|encoded_param_string\n\n

Then generate hash:

signature = HMAC_SHA256(message, secret_key)\n\n

Return lowercase hexadecimal string.

5. Complete Pre-request 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 => `${encodeURIComponent(key)}=${encodeURIComponent(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 queryObj = {};\n    pm.request.url.query.all().forEach(param => {\n        if (param.disabled !== true && param.key !== 'access_key' && param.key !== 'nonce') {\n            const key = param.key.replace(/\\[\\]$/, '');\n            if (queryObj[key] === undefined) queryObj[key] = param.value;\n            else if (Array.isArray(queryObj[key])) queryObj[key].push(param.value);\n            else queryObj[key] = [queryObj[key], param.value];\n        }\n    });\n    const sortedKeys = Object.keys(queryObj).sort();\n    dataToSign = sortedKeys.map(key => {\n        const value = queryObj[key];\n        const valueStr = Array.isArray(value) ? value.join(',') : value;\n        return `${encodeURIComponent(key)}=${encodeURIComponent(valueStr)}`;\n    }).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(\"String to sign: \" + message);\n\n

6. Error Handling

Missing or invalid headers produce:

{\n  \"statusCode\": 401,\n  \"message\": \"Token expired or not exist\",\n  \"error\": \"Unauthorized\"\n}\n\n

Common causes:

using initial registration keys (instead of session keys)
\n
wrong parameter sorting
\n
incorrect endpoint path
\n
forgetting encodeURIComponent
\n
uppercase HEX signature
\n
invalid session keys (expired, rotated)
\n

8. Best Practices

Always login via /sessions before performing operations
\n
Replace keys once expired (expire_at)
\n
Never store secret_key in front-end or mobile apps
\n
Rotate keys if compromised
\n
Log string to sign during debugging
\n
Protect Auth-Token as a privileged credential
\n
Use HTTPS only
\n

9. Summary

Your integration must follow this exact flow:

Use Auth-Token → register member
\n
Receive initial access_key + secret_key
\n
Use them to call /sessions
\n
Use session-level access_key + secret_key for all operations
\n
Sign every request using strict HMAC rules
\n

This ensures secure, traceable, cryptographically validated interaction with the Kyrrex Business API.

\n","_postman_id":"46365601-66d3-4082-8107-fa1eea732f07","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"30cf573a-c182-40d5-a0c9-80d82e637d57","id":"30cf573a-c182-40d5-a0c9-80d82e637d57","name":"Kyrrex Malta Business","type":"collection"}}},{"name":"KYC & KYB Verification","item":[],"id":"7e091268-59b5-4316-94ea-1c66a36b4fde","description":"

Business API Verification Flow

KYC (Know Your Customer) and KYB (Know Your Business) verification flows ensure regulatory compliance and identity validation for both individual users and legal entities on the Kyrrex Business Platform.

The API does not handle document upload or data submission directly.

Instead, it generates secure tokens and web links that allow users to complete verification using an external provider (e.g., Sumsub).

All verification operations fall into two parts:

KYC – individual user identity verification
\n
KYB – company verification for legal entities
\n

1. KYC Verification (Individual Users)

KYC is required for members (admins, operators, employees, traders) who perform any operational actions within the Business API.

The collection includes exactly four KYC-related endpoints.

1.1 Generate KYC Token

POST /api/v1/business/kyc/generate_token

Generates a one-time verification token that initializes a KYC session with the external verification provider.

Purpose:

Start the KYC verification session
\n
Authorize a user inside the verification provider
\n
Pass the token to a Web SDK or hosted verification page
\n

Example response:

{\n  \"token\": \"kyc_token_here\",\n}\n\n

This token must be used by the client application to launch the provider’s verification UI.

1.2 Generate KYC Web Link

POST /api/v1/business/kyc/generate_web_link

Returns a fully qualified URL that redirects the user to the hosted KYC page.

Used when:

the platform prefers redirect-based onboarding
\n
KYC is completed outside the application
\n
embedding a Web SDK is not required
\n

Example:

{\n  \"url\": \"https://kyc-provider.com/session/abc123\"\n}\n\n

1.3 Shared Token

POST /api/v1/business/kyc/shared_token

Generates a token intended for:

shared verification contexts
\n
passing verification to partner applications
\n
enabling KYC inside an iframe
\n
synchronizing verification between separate UIs
\n

This is a service-level endpoint allowing you to recreate a valid verification context for the same user.

1.4 Get KYC Levels

GET /api/v1/business/kyc/levels

Returns the list of available KYC levels defined for the Business API and shows the current user’s verification status.

Used for:

displaying verification progress
\n
determining which levels are approved or pending
\n
enabling or restricting platform functionality based on level
\n

Example response:

{\n  \"levels\": [\n    { \"level\": 1, \"status\": \"approved\" },\n    { \"level\": 2, \"status\": \"pending\" }\n  ]\n}\n\n

2. KYB Verification (Legal Entity)

KYB is mandatory for all companies using the platform to enable:

fiat operations
\n
deposit and withdrawal providers
\n
card/bank instruments
\n
corporate account structure
\n

All KYB operations follow the Hosted KYB Web Flow model.

the system provide a token and the user completes KYB via a browser page or embedded provider UI.

2.1 Generate KYB Token

POST /api/v1/business/kyb/generate_token

Creates a token required to initialize a KYB verification session with the external provider.

Example:

{\n  \"token\": \"kyb_token_here\",\n}\n\n

This token is used to generate a web link or to launch provider SDK flows.

2.2 Generate KYB Web Link

POST /api/v1/business/kyb/generate_web_link

Provides a fully constructed URL to the external KYB onboarding page.

Purpose:

allow the company to complete KYB in a secure hosted environment
\n
upload corporate documents
\n
provide corporate structure
\n
verify directors / UBOs
\n
finalize compliance checks
\n

Example:

{\n  \"url\": \"https://kyb-provider.com/company/flow/xyz\"\n}\n\n

2.3 Get Legal Entity Info

GET /api/v1/business/kyb/legal_entity_info

Fetches the current legal entity information assigned to the business account.

This endpoint:

does NOT start KYB
\n
returns stored company data
\n
allows the frontend to check whether KYB has been completed
\n
is used to display company details in UI
\n

Fields typically include:

legal name
\n
registration number
\n
incorporation country
\n
legal address
\n
KYB status
\n
timestamps
\n

Example:

{\n  \"legal_name\": \"Example LTD\",\n  \"country\": \"GB\",\n  \"registration_number\": \"12345678\",\n  \"status\": \"pending\"\n}\n\n

3. Business Logic Summary

KYC

Token-based initiation
\n
Optional hosted verification link
\n
Verification occurs externally
\n
Status is trackable through /kyc/levels
\n

KYB

Token-based session creation
\n
Hosted KYB verification flow (external)
\n
No document handling in Business API
\n
Status and company info retrievable from /kyb/legal_entity_info
\n

5. Key Notes for Integrators

All verification workflows use session-level keys (APIKey + APISign).
\n
The Business API never processes documents directly.
\n
KYC/KYB must be completed before enabling financial operations.
\n
Tokens must be used by the frontend only (never in backend-to-backend signing).
\n
Web links expire based on provider configuration.
\n
legal_entity_info should be polled by the frontend after KYB completion.
\n

\n","_postman_id":"7e091268-59b5-4316-94ea-1c66a36b4fde","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"30cf573a-c182-40d5-a0c9-80d82e637d57","id":"30cf573a-c182-40d5-a0c9-80d82e637d57","name":"Kyrrex Malta Business","type":"collection"}}},{"name":"On-Ramp Process","item":[],"id":"a03bf381-71a9-40a4-a799-13f304f554d7","description":"

Prerequisites

Before starting the on-ramp flow, the user must already be fully onboarded in the Business API environment.

All of the following conditions must be met:

1. The business must hold a valid Auth-Token

The Auth-Token is issued manually by the Kyrrex Operations team and is required to perform any Owner-level API actions.

2. The user (member) must be created and registered

The member must exist in the system and must receive initial access_key and secret_key via the registration and login flow.

3. The user must be successfully logged in

After completing the /sessions login flow, the user must use the session-level access_key and secret_key to sign all operational requests.

Without active session keys, no operational endpoints can be executed.

4. All requests must be signed

Every endpoint used in the on-ramp process requires HMAC-SHA256 signature authentication.

Important:

All operational webhooks are configured internally by Kyrrex Operations after the Auth-Token is issued.

Clients do not register webhook URLs via the API.

Overview of the On-Ramp Flow

The on-ramp process consists of three sequential stages:

Fiat onboarding & deposit
\n
Registering with a fiat provider, creating the payment instrument, and performing the deposit.
\n
Exchange (fiat → crypto)
\n
Converting deposited fiat into cryptocurrency.
\n
Crypto withdrawal
\n
Sending the acquired cryptocurrency to an external blockchain wallet.
\n

Every step must be executed strictly in sequence.

1. Provider Selection and Customer Registration

A user must be linked to a supported fiat provider and have at least one payment instrument before initiating a deposit.

1.1 Retrieve available fiat providers

GET /api/v1/business/fiat/providers/deposits

Returns:

available providers
\n
supported fiat currencies
\n
supported instruments:
\n
- SEPA- (Clear Junction )
  \n
- SEPA_IFRAME (Volt)
  \n
- Card_s (Corefy)
  \n
\n

The user chooses:

provider
\n
instrument type
\n

This selection defines all further steps.

1.2 Register the customer with the selected provider

POST /api/v1/business/fiat/:provider_id/customers

Creates a customer profile at the selected provider.

1.3 Check provider registration status

GET /api/v1/business/fiat/providers/:provider_id/customers

The system must wait until the provider returns verified status.

Only after verification the user can proceed to instrument registration.

2. Registering the Deposit Instrument

Instrument registration varies depending on the selected instrument type.

2.1 Register SEPA / SEPA_IFRAME bank transfer instruments

POST /api/v1/business/fiat/providers/:provider_id/instruments/bank_transfers

Creates a bank transfer instrument used for SEPA and SEPA_IFRAME providers.

Clear Junction / Fiat Republic → SEPA
\n
Volt → SEPA_IFRAME
\n

2.2 Register Card_s instrument (Corefy)

This step applies only to the Corefy provider (instrument type card_s).

2.2.1 Create the Card_s instrument

POST /api/v1/business/fiat/providers/:provider_id/instruments/cards

Example body:

{\n\"instrument\": \"card_s\"\n}\n\n

The system creates a New Card instrument (card_s) and returns its UID.

This UID must be used in the deposit request.

2.2.2 Retrieve all saved cards

GET /api/v1/business/fiat/providers/:provider_id/instruments/cards

This returns:

all previously saved cards
\n
the special New Card entry - used when the user wants to add another card
\n

The user may choose:

an existing saved card UID
\n
or New Card UID to register a new one during the iframe deposit step.
\n

2.3 Check instrument registration status

GET /api/v1/business/fiat/providers/:provider_id/customers

This confirms that the provider has validated the created instrument.

Only after verification the user may proceed with the deposit.

2.4 Retrieve bank transfer details (SEPA / SEPA_IFRAME)

GET /api/v1/business/fiat/providers/:provider_id/instruments/bank_transfers?instrument=...

Returns:

IBAN
\n
bank name
\n
beneficiary name , etc..
\n

These details are used for manual SEPA/SEPA_iframe deposits.

3. Performing a Fiat Deposit

Once the provider and instrument are ready, the user can initiate a fiat deposit.

3.1 Retrieve general deposit fees

GET /api/v1/business/fiat/deposits/fees

Returns base fee rules for all providers.

3.2 Estimate deposit fees for a specific amount

GET
/api/v1/business/fiat/deposits/fees/estimate?provider_id=...&instrument=...&amount=...

Returns exact fee calculation based on:

provider
\n
instrument
\n
deposit amount
\n

This data must be shown to the end user.

3.3 Execute Deposi

A) Corefy (Card_s):

POST /api/v1/business/fiat/deposits

Use the card_s UID from step 2.2
\n
The API returns an iframe redirect URL
\n
The user enters card details inside the iframe
\n
The card is automatically saved for future operations
\n

B) Volt (SEPA_IFRAME)

POST /api/v1/business/fiat/deposits

The API returns an iframe redirect URL to Volt
\n
The user completes the SEPA transfer flow inside the iframe
\n

C) Clear Junction / Fiat Republic (SEPA)

User transfers funds manually from their external bank
\n
Payment details were previously obtained from step 2.4
\n
No iframe is used
\n

3.4 Retrieve deposit history

GET /api/v1/business/fiat/deposits

Used to track deposit statuses at any point.

4. Fiat → Crypto Exchange

After the fiat deposit is credited, the user may convert fiat into crypto.

4.1 Retrieve available markets

GET /api/v1/business/markets?page=1&per_page=10&type=fiat

Returns all fiat→crypto markets.

4.2 Retrieve market settings (fees, min-order)

GET /api/v1/business/settings/markets

Shows fee rules and minimum order requirements for each market.

4.3 Get exchange estimate

GET /api/v1/business/exchanges/estimate?input_asset=...&output_asset=...&amount=...

Returns expected crypto amount and total fee.

4.4 Execute fiat→crypto exchange

POST /api/v1/business/exchanges

Performs the actual conversion and credits crypto to the user’s balance.

5. Crypto Withdrawal

After receiving cryptocurrency, the user may withdraw it externally.

5.1 Create or select a withdrawal requisite

Create:

POST /api/v1/business/requisites

List existing:

GET /api/v1/business/requisites

5.2 Retrieve crypto asset settings

GET /api/v1/business/settings/currencies

Shows:

withdrawal availability
\n
limits
\n
fees etc.
\n

5.3 Initiate the withdrawal

POST /api/v1/business/withdrawals

Additional verifications (Travel Rule) may require: if limits reached:

Generate Token
\n
Generate Web Link
\n

5.4 Retrieve withdrawal history

GET /api/v1/business/withdrawals

Shows status, fee, blockchain hash (when available), timestamps.

6. End-to-End Flow Summary

\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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Step	Description	Endpoint
1	Fetch fiat providers and supported instruments	GET `/fiat/providers/deposits`
2	Register customer with provider	POST `/fiat/:provider_id/customers`
3	Check registration status	GET `/fiat/providers/:provider_id/customers`
4	Register SEPA / SEPA_IFRAME instrument	POST `/fiat/providers/:provider_id/instruments/bank_transfers`
4.1	Register Card_s instrument (Corefy), fetch Card UID	POST `/fiat/providers/:provider_id/instruments/cards_s` → GET `/fiat/providers/:provider_id/instruments/cards`
5	Check instrument status	GET `/fiat/providers/:provider_id/customers`
6	Retrieve bank transfer details	GET `/fiat/providers/:provider_id/instruments/bank_transfers?instrument=...`
7	Retrieve deposit fees	GET `/fiat/deposits/fees`
8	Estimate deposit fee	GET `/fiat/deposits/fees/estimate`
9	Execute fiat deposit	POST `/fiat/deposits`
10	Retrieve deposits	GET `/fiat/deposits`
11	Fetch fiat→crypto markets	GET `/markets?type=fiat`
12	Market settings (fees, limits)	GET `/settings/markets`
13	Exchange estimate	GET `/exchanges/estimate`
14	Execute exchange	POST `/exchanges`
15	Create/select withdrawal requisite	POST / GET `/requisites`
16	Crypto asset settings	GET `/settings/currencies`
17	Initiate withdrawal	POST `/withdrawals`
18	Retrieve withdrawals	GET `/withdrawals`

","_postman_id":"a03bf381-71a9-40a4-a799-13f304f554d7","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"30cf573a-c182-40d5-a0c9-80d82e637d57","id":"30cf573a-c182-40d5-a0c9-80d82e637d57","name":"Kyrrex Malta Business","type":"collection"}}},{"name":"On - Ramp through Advanced Exchange","item":[],"id":"8307008a-6f92-4f13-901d-ea75f5a2f9cf","description":"

Fiat Deposit (From Card Only) → Instant Fiat-to-Crypto Conversion → Crypto Withdrawal

The Advanced Exchange is an alternative on-ramp method that combines the fiat deposit and fiat→crypto conversion into a single atomic operation.

Unlike the standard on-ramp flow—where deposit and exchange are two separate steps—the Advanced Exchange performs both operations in one request.

Because this flow uses Card_s, it is supported only through the Corefy provider.

Prerequisites

Before initiating the Advanced Exchange flow, all of the following conditions must be met:

1. Valid Auth-Token

A valid Auth-Token must be issued to the business by the Kyrrex Operations team.

2. Member Registration

The user (member) must be created and registered within the system.

\n\n

The user must complete the /sessions login flow and use the session-level access_key and secret_key.

4. HMAC Signatures Required

All operational requests must be signed using the HMAC-SHA256 signature mechanism.

5. Webhooks Are Preconfigured Internally

Webhooks for deposits, advanced exchanges, and withdrawals are configured by Kyrrex Operations.

Clients do not register or manage webhook endpoints.

After successful authentication and session creation, the client may proceed with the Advanced Exchange steps below.

1. Provider Selection

Advanced Exchange supports only:

Provider: Corefy
\n
Instrument type: Card_s
\n

The process begins by selecting the Corefy provider.

1.1 Fetch available fiat providers

GET /api/v1/business/fiat/providers/deposits

The response contains all fiat providers and their supported instruments.

The client must select:

provider_id = cruer
\n
instrument = card_s
\n

No other provider or instrument type is compatible with Advanced Exchange.

2. Customer Registration at Corefy

The user must be registered with Corefy before they can register a card or initiate an Advanced Exchange.

2.1 Register customer at provider

POST /api/v1/business/fiat/:provider_id/customers

Creates a customer profile at Corefy.

2.2 Check registration status

GET /api/v1/business/fiat/providers/:provider_id/customers

The system must wait until Corefy confirms the customer’s registration.

Only after the status becomes verified can the flow continue.

3. Registering the card_s Instrument

The Advanced Exchange can only be performed using a card_s instrument.

This flow differs from the standard SEPA-based flow and requires card initialization.

3.1 Create a card_s Instrument (New Card)

POST /api/v1/business/fiat/providers/:provider_id/instruments/cards

Example:

{\n\"instrument\": \"card_s\"\n}\n\n

This creates a New Card entry of type card_s.

The system must use the UID of this New Card when executing the Advanced Exchange.

3.2 Retrieve all registered cards (including New Card)

GET /api/v1/business/fiat/providers/:provider_id/instruments/cards

The response includes:

all previously saved card instruments
\n
the special New Card record used if the user wants to add a new card during the deposit flow
\n

The Card UID from this list must be used in the deposit step of the Advanced Exchange.

4. Fiat → Crypto Conversion via Advanced Exchange

Once the Card_s instrument is active and verified, the user can begin the Advanced Exchange process.

4.1 Retrieve available fiat markets

GET /api/v1/business/markets?page=1&per_page=10&type=fiat

Returns the list of fiat→crypto markets available for conversion.

4.2 Retrieve market configuration

GET /api/v1/business/settings/markets

Returns:

fee configuration
\n
minimum order amounts
\n
trading limits
\n

These settings must be shown to the user before executing the operation.

4.3 Calculate Advanced Exchange estimate

GET
/api/v1/business/advanced_exchanges/estimate?fiat_currency=eur&crypto_asset=trx&fiat_amount=100&provider_id=creur

Returns:

expected crypto output
\n
estimated total fee
\n
exchange rate information
\n
provider-specific commission
\n

This result must be displayed to the end user before the final action is performed.

5. Execute Advanced Exchange (Deposit + Exchange)

5.1 Perform the combined operation

POST /api/v1/business/advanced_exchanges

The request contains:

\"deposit_address_uid\": 7754,
\n
\"fiat_currency\": \"EUR\",
\n
\"crypto_asset\": \"BTC\",
\n
\"fiat_amount\": 100,
\n
\"payment_method\": \"card_s\",
\n
\"provider_id\": \"creur\",
\n

The operation performs simultaneously:

Fiat deposit from the card_s instrument
\n
Instant conversion of the deposited amount into crypto
\n

The resulting cryptocurrency is credited directly to the user’s crypto balance.

There is no separate fiat deposit step and no separate exchange step:

everything is executed atomically within a single request.

5.2 Retrieve Advanced Exchange history

GET /api/v1/business/advanced_exchanges

Returns all completed and pending Advanced Exchange operations.

6. Crypto Withdrawal (Optional Final Step)

If the user wants to withdraw the crypto received from the Advanced Exchange, the standard crypto withdrawal flow applies.

6.1 Create or select a withdrawal requisite

Create a new address:
POST /api/v1/business/requisites

Retrieve saved addresses:
GET /api/v1/business/requisites

6.2 Retrieve crypto settings

GET /api/v1/business/settings/currencies

Shows fees, minimum withdrawal amounts, memo/tag rules, and availability.

6.3 Initiate the crypto withdrawal

POST /api/v1/business/withdrawals

Triggers the withdrawal to the selected requisite.

6.4 Retrieve withdrawal history

GET /api/v1/business/withdrawals

Displays withdrawal statuses and blockchain transaction details.

End-to-End Advanced Exchange Flow Summary

\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

Step	Description	Endpoint
1	Fetch fiat providers (select Corefy + Card_s)	GET `/fiat/providers/deposits`
2	Register customer at Corefy	POST `/fiat/:provider_id/customers`
3	Check provider registration status	GET `/fiat/providers/:provider_id/customers`
4	Register Card_s instrument (New Card)	POST `/fiat/providers/:provider_id/instruments/cards_s`
5	Retrieve Card UID list	GET `/fiat/providers/:provider_id/instruments/cards`
6	Fetch fiat→crypto markets	GET `/markets?type=fiat`
7	Retrieve market settings	GET `/settings/markets`
8	Advanced Exchange estimate	GET `/advanced_exchanges/estimate`
9	Execute Advanced Exchange (deposit + conversion)	POST `/advanced_exchanges`
10	Retrieve Advanced Exchange history	GET `/advanced_exchanges`
11	Create/select crypto withdrawal requisite	POST/GET `/requisites`
12	Retrieve crypto settings	GET `/settings/currencies`
13	Execute crypto withdrawal	POST `/withdrawals`
14	Retrieve withdrawal history	GET `/withdrawals`

","_postman_id":"8307008a-6f92-4f13-901d-ea75f5a2f9cf","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"30cf573a-c182-40d5-a0c9-80d82e637d57","id":"30cf573a-c182-40d5-a0c9-80d82e637d57","name":"Kyrrex Malta Business","type":"collection"}}},{"name":"Off-Ramp Process","item":[],"id":"f82f651c-7adf-479d-ad28-5dff1fadedec","description":"

Off-Ramp Process (Crypto Deposit → Swap → Fiat Withdrawal)

Full operational flow for converting crypto into fiat and withdrawing it through a supported provider.

The Off-Ramp flow begins with the user depositing cryptocurrency to the platform.

Only after the crypto deposit is confirmed can the user swap it into fiat and withdraw fiat externally.

This article describes the full Off-Ramp process with all correct endpoints, updated per your notes.

Prerequisites

Before starting the Off-Ramp flow:

The business must have a valid Auth-Token.
\n
The user must be created, registered, and logged in using session-level access_key and secret_key.
\n
All requests must be signed using HMAC SHA-256.
\n
The user must satisfy all KYC/KYB levels required for fiat withdrawals.
\n
Crypto must be deposited first.
\n

1. Crypto Deposit

This is the entry point for Off-Ramp.

1.1 Get supported crypto assets

GET /api/v1/business/settings/currencies

Used to:

verify which assets support deposit
\n
check available networks and limits
\n

1.2 Create a deposit address

POST /api/v1/business/deposit_addresses

Creates a new blockchain deposit address for the chosen asset and network.

1.3 Retrieve existing deposit addresses

GET /api/v1/business/deposit_addresses

Returns all previously created deposit addresses.

1.4 User sends crypto to the deposit address

The user performs an on-chain transfer.

After sufficient confirmations, the crypto appears on the user’s balance.

1.5 Retrieve crypto deposits

GET /api/v1/business/deposits

Allows the client to track deposits

Once the deposit is confirmed → user can proceed to fiat conversion.

2. Convert Crypto → Fiat (Swap)

The user must convert deposited crypto into EUR (or other supported fiat) before performing fiat withdrawal.

2.1 Retrieve available crypto→fiat markets

GET /api/v1/business/markets?page=1&per_page=10&type=fiat

Returns all fiat markets available for exchange.

2.2 Get market settings

GET /api/v1/business/settings/markets

Contains:

trading fees
\n
minimum order sizes
\n
supported pairs
\n

2.3 Get swap estimate

GET
/api/v1/business/exchanges/estimate?input_asset=...&output_asset=eur&amount=...

Returns:

estimated fiat output
\n
fee breakdown
\n

2.4 Execute crypto→fiat swap

POST /api/v1/business/exchanges

After execution, the fiat amount appears on the balance and becomes available for external withdrawal.

3. Provider Selection and Setup for Fiat Withdrawal

3.1 Fetch fiat providers

GET /api/v1/business/fiat/providers/deposits

Although designed for deposits, this endpoint also indicates:

which providers your environment supports
\n
which fiat currencies they support
\n
which payout instruments they offer (SEPA, SEPA_IFRAME, Card_s)
\n

3.2 Register customer at provider

POST /api/v1/business/fiat/:provider_id/customers

Registers the user with the selected fiat provider.

2.3 Check provider registration status

GET /api/v1/business/fiat/providers/:provider_id/customers

You must wait until the provider returns verified.

3. Register a Fiat Payout Instrument

3.1 Bank Transfer (SEPA / SEPA_IFRAME)

POST
/api/v1/business/fiat/providers/:provider_id/instruments/bank_transfers

Used to register a payout instrument for:

SEPA
\n
SEPA_IFRAME
\n

3.2 Card (Corefy provider) payout instrument

POST api/v1/business/fiat/providers/creur/instruments/cards

Creates a new card_s payout instrument.

Then retrieve Card UID:

GET
/api/v1/business/fiat/providers/:provider_id/instruments/cards

You will use the Card UID when performing fiat withdrawals.

3.3 Check payout instrument status registration

GET /api/v1/business/fiat/providers/:provider_id/customers

Ensures the provider verified the instrument.

4. Execute Fiat Withdrawal

4.1 Retrieve fiat withdrawal fees

GET /api/v1/business/fiat/withdrawals/fees

Returns:

provider fee
\n
network fee (if any)
\n
minimum/maximum supported withdrawal amounts
\n

4.2 Perform fiat withdrawal

POST /api/v1/business/fiat/withdrawals

The request to the card includes:

\"payout_method\": \"card\",
\n
\"instrument\": \"card_s\",
\n
\"provider_id\": \"creur\",
\n
\"amount\": 10.00,
\n
\"currency\": \"EUR\",
\n
\"withdrawal_address_uid\": 6822
\n

The request to the bank transfer requesites includes:

\"payout_method\": \"bank_transfer\",
\n
\"instrument\": \"sepa\", // can be \"sepa\", \"sepa_iframe\"
\n
\"provider_id\": \"creur\",
\n
\"amount\": 100.00,
\n
\"currency\": \"EUR\",
\n
\"iban\": \"DE89370400440532013000\",
\n
\"first_name\": \"John\",
\n
\"last_name\": \"Doe\",
\n
\"country_id\": 276,
\n
\"address\": \"Berliner Straße 12\",
\n
\"city\": \"Berlin\",
\n
\"postcode\": \"10115\"
\n

The provider processes the payout and sends status updates internally.

4.3 Retrieve fiat withdrawal history

GET /api/v1/business/fiat/withdrawals

Used to track:

pending payouts
\n
completed payouts
\n
failed/declined payouts
\n

Final Off-Ramp Flow Summary

Step	Description	Endpoint
0	Create deposit address	POST /deposit_addresses
0.1	Get deposit addresses	GET /deposit_addresses
0.2	User sends crypto on-chain	—
0.3	Track crypto deposits	GET /deposits
1	Get fiat markets	GET /markets?type=fiat
2	Get market settings	GET /settings/markets
3	Crypto→fiat estimate	GET /exchanges/estimate
4	Execute swap	POST /exchanges
5	Fetch fiat providers (SEPA / SEPA_IFRAME / Card_s)	GET /fiat/providers/deposits
6	Register provider customer	POST /fiat/:provider_id/customers
7	Check provider status	GET /fiat/providers/:provider_id/customers
8	Register SEPA or SEPA_IFRAME instrument	POST /fiat/providers/:provider_id/instruments/bank_transfers
9	Register Card_s instrument	POST /fiat/providers/creur/instruments/cards
9.1	Retrieve Card UID	GET /fiat/providers/:provider_id/instruments/cards
10	Check instrument status	GET /fiat/providers/:provider_id/customers
11	Get fiat withdrawal fees	GET /fiat/withdrawals/fees
12	Execute fiat withdrawal	POST /fiat/withdrawals
13	Withdrawal history	GET /fiat/withdrawals

","_postman_id":"f82f651c-7adf-479d-ad28-5dff1fadedec","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"30cf573a-c182-40d5-a0c9-80d82e637d57","id":"30cf573a-c182-40d5-a0c9-80d82e637d57","name":"Kyrrex Malta Business","type":"collection"}}},{"name":"Webhooks","item":[],"id":"7bdd29f1-c6cb-4f20-a698-a5b94b0e35cd","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":"7bdd29f1-c6cb-4f20-a698-a5b94b0e35cd","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"30cf573a-c182-40d5-a0c9-80d82e637d57","id":"30cf573a-c182-40d5-a0c9-80d82e637d57","name":"Kyrrex Malta Business","type":"collection"}}},{"name":"Info Endpoints Description","item":[],"id":"1d876602-75a1-4b04-90b0-a5eeedc557f5","description":"

Information & Reference Endpoints

(Business API — Tools, Assets, Markets, VASPs)**

This section describes all informational and reference endpoints available in the Business API.

These endpoints do not perform financial operations; instead, they provide metadata required for building onboarding flows, validating user input, configuring payment routes, and displaying correct data inside client applications.

All endpoints in this section require session-level authentication and HMAC signature.

1. Countries & Country Codes

These endpoints return information about supported countries and ISO-based country identifiers.

1.1 Retrieve Supported Countries

GET /api/v1/business/tools/countries

Returns the full list of countries supported by the platform, including:

code — ISO Alpha-2 code
\n
eng_name — country name
\n
iso — numeric ISO code
\n
location — region classification
\n
id — internal country identifier
\n

Example Response

{\n  \"code\": \"EE\",\n  \"eng_name\": \"Estonia\",\n  \"id\": 992,\n  \"iso\": 233,\n  \"location\": \"Other\"\n},\n{\n  \"code\": \"FR\",\n  \"eng_name\": \"France\",\n  \"id\": 972,\n  \"iso\": 250,\n  \"location\": \"Other\"\n}\n\n

This list is typically used for:

user onboarding flows
\n
address forms
\n
regulatory checks
\n
compliance validations
\n

1.2 Retrieve All Supported Country Codes

GET /api/v1/business/tools/countries/all_codes

Returns only the Alpha-2 country codes without additional metadata.

Useful when only a compact list of country identifiers is required.

2. VASPs (Travel Rule Providers)

These endpoints return information about Virtual Asset Service Providers used for Travel Rule compliance.

2.1 Retrieve VASP Directory

GET /api/v1/business/tools/vasps

Returns the list of VASPs that the platform is integrated with for Travel Rule operations.

The response includes provider-specific metadata required for:

validating destination addresses
\n
routing Travel Rule messages
\n
determining supported jurisdictions
\n

This endpoint is used during crypto withdrawal flows where Travel Rule checks may apply.

3. Currencies & Asset Metadata

These endpoints provide asset-level configuration, availability rules, and fee parameters.

3.1 Retrieve Supported Currencies

GET /api/v1/business/settings/currencies

Returns configuration for every supported cryptocurrency and fiat currency:

withdrawal availability
\n
deposit availability
\n
minimum limits
\n
fee structure (fixed + percentage)
\n
memo/tag requirements
\n
blockchain network information
\n

This endpoint is essential for:

displaying available assets
\n
validating withdrawal inputs
\n
showing fees before executing transactions
\n

3.2 Retrieve All Assets

GET /api/v1/business/assets?active_deposit=true&active_withdrawal=true&page=1&per_page=50

Returns all assets filtered by deposit/withdrawal availability.

Includes:

asset code
\n
asset type (crypto / fiat)
\n
blockchain networks
\n
operational flags
\n

3.3 Retrieve Asset Details by Code

GET /api/v1/business/assets/:code

Returns detailed information for a specific asset, including:

precision
\n
fee configuration
\n
operational status
\n
network requirements
\n

4. Markets (Fiat & Crypto Trading Pairs)

These endpoints provide access to all available markets and their operational parameters.

4.1 Retrieve All Markets

GET /api/v1/business/markets

Returns the list of trading markets including:

fiat→crypto pairs
\n
crypto→crypto pairs
\n
market identifiers
\n
supported assets
\n
direction and type
\n

Used for building exchange interfaces and validating conversion operations.

4.2 Retrieve Market Details

GET /api/v1/business/markets/:market

Returns complete details for the specified market:

base and quote assets
\n
market direction
\n
minimum order rules
\n
operational flags
\n
internal reference identifiers
\n

Useful when a client needs to validate a market before executing an exchange.

Summary Table

\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

Category	Description	Endpoint
Countries	Full supported country list	GET `/tools/countries`
Country Codes	Alpha-2 codes only	GET `/tools/countries/all_codes`
VASPs	Supported Travel Rule providers	GET `/tools/vasps`
Currencies	Configuration for all currencies	GET `/settings/currencies`
All Assets	List of assets (with filters)	GET `/assets`
Asset Details	Asset metadata by code	GET `/assets/:code`
Markets	All fiat/crypto markets	GET `/markets`
Market Details	Market metadata by ID	GET `/markets/:market`

","_postman_id":"1d876602-75a1-4b04-90b0-a5eeedc557f5","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"30cf573a-c182-40d5-a0c9-80d82e637d57","id":"30cf573a-c182-40d5-a0c9-80d82e637d57","name":"Kyrrex Malta Business","type":"collection"}}}],"id":"272f5342-aca7-4432-9068-2fa9b2682d7b","description":"

This section provides a high-level introduction to the Kyrrex Malta Business API and explains the core concepts required to integrate financial operations into your application.

It is designed to give developers a fast and clear understanding of how authentication, request signing, and operational flows work across the platform.

What This API Provides

The Kyrrex Business API allows you to integrate a full suite of financial services into your product, including:

Member onboarding and authentication
\n
Secure operational sessions
\n
Fiat deposits and withdrawals
\n
Crypto deposits, withdrawals, and swap/exchange operations
\n
Account and balance management
\n
Requisites registration and usage
\n
Markets availability
\n
Webhooks for asynchronous updates
\n

All operations follow a unified security and signature model to guarantee data integrity and controlled access.

Key Authentication Model

The platform uses two independent authorization layers, each serving a different purpose:

1. Owner-Level Token (Auth-Token)

Used for business-level or administrative actions such as:

Creating new members
\n
Managing company-level resources
\n
Generating initial access keys for operational sessions
\n

This token must always be protected, as it provides full privileged access.

2. Operational Keys (access_key + secret_key)

After creating or logging in a member, you receive a pair of operational keys:

access_key — public identifier of the API client
\n
secret_key — used to generate an HMAC-SHA256 signature for every request
\n

These keys authorize all business and trading operations performed after login.

Keys include creation and expiration timestamps and must be rotated when expired.

Signing Every Request

Every request must include:

APIKey: {access_key}\nAPISign: {generated_signature}\nAuth-Token: {owner_token}\n\n

The signature is generated using the following pattern:

{HTTP_METHOD}|{ENDPOINT_PATH}|{SORTED_PARAMETERS}\n\n

Where sorted parameters represent either:

all active query params (GET)
\n
a flattened JSON body (POST/PUT/PATCH/DELETE)
\n

Signature must be generated using HMAC-SHA256(secret_key) and sent in lowercase hex.

Sequence to Start Using the API

A typical integration workflow looks like this:

Obtain Auth-Token (provided by the Kyrrex team).
\n
Create a member via /members/sign-up.
\n
Obtain member-level keys (access_key & secret_key).
\n
Create an operational session /sessions to get fresh session keys.
\n
Use operational keys to:
\n
- fetch balances
  \n
- register requisites
  \n
- create deposits
  \n
- initiate withdrawals
  \n
- perform crypto/fiat conversions
  \n
- listen to webhook updates
  \n
\n

This sequence ensures separation between privileged owner access and operational member access, improving security and auditability.

Working with Financial Operations

Once authenticated, you can integrate the main flows:

Fiat Deposits (On-Ramp)

Register or retrieve deposit requisites
\n
Create deposit operations
\n
Track deposit statuses via API or Webhooks
\n

Fiat Withdrawals (Off-Ramp)

Register bank accounts (requisites)
\n
Submit withdrawal requests
\n
Handle success/failure via Webhooks
\n

Crypto Operations

Generate deposit addresses
\n
Track incoming transactions
\n
Initiate blockchain withdrawals
\n
Perform swaps or advanced exchange operations
\n

Accounts & Balances

Retrieve balances.

Everything follows the same signing and authorization rules.

Error Handling & Rate Limits

The API provides consistent error responses, including signature validation failures, missing headers, and expired tokens:

{\n  \"statusCode\": 401,\n  \"message\": \"Token expired or not exist\",\n  \"error\": \"Unauthorized\"\n}\n\n

Rate limit headers:

X-Ratelimit-Limit
\n
X-Ratelimit-Remaining
\n
X-Ratelimit-Reset
\n

These help you build proper retry logic and avoid request rejection.

Security Best Practices

Always use HTTPS.
\n
Never expose secret_key in client-side or public code.
\n
Rotate keys when expire_at is reached.
\n
Protect Auth-Token as a highly privileged credential.
\n
Validate webhook signatures (recommended).
\n
Log all API errors for audit purposes.
\n

What to Read Next

Inside this Getting Started folder you will find short guides covering:

How authentication works
\n
How to sign requests
\n
How to create deposits and withdrawals
\n
How webhooks work
\n
How to work with requisites
\n
How to read balances and accounts
\n
How crypto deposits and withdrawals operate
\n

Each guide is focused, practical, and includes only what you need to start integrating quickly and safely.

\n","_postman_id":"272f5342-aca7-4432-9068-2fa9b2682d7b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"30cf573a-c182-40d5-a0c9-80d82e637d57","id":"30cf573a-c182-40d5-a0c9-80d82e637d57","name":"Kyrrex Malta Business","type":"collection"}}},{"name":"members","item":[{"name":"me","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"d06285e7-a763-48d0-a76f-ee23756f3214"}}],"id":"b7de6ac3-d00e-4c5f-82e0-6e23393f9c02","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":"81e6134a-d268-4a46-bfcc-c7558b6657c1","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":"506ecf6b-b4a7-418c-9b7f-5ef37df40403"},{"name":"sign-up","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"ae5bc094-a2c2-4a0c-ad8f-ba537c529105"}},{"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":"b76a0f05-210f-4d49-89c0-4dd63a9aeaad"}}],"id":"626ec5c1-63f0-491c-816e-292c00a26d44","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

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

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
Endpoint: https://my.kyrrex.mt/api/v1/business/tools/identification_documents

Response

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

[\n  {\n    \"id\": \"number\",\n    \"name\": \"string\"\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 is used to share a KYC (Know Your Customer) token, which is essential for verifying the identity of users in business transactions.

Request

Method: POST
\n
URL: https://my.kyrrex.mt/api/v1/business/kyc/shared_token
\n

Request Body

The request body must be in JSON format and should contain the following parameter:

shareToken (string): A JWT (JSON Web Token) that represents the KYC information to be shared. This token is crucial for the authentication and authorization process during KYC verification.

Expected Response

Upon successful processing of the request, the API will return a response indicating the status of the KYC token sharing. The response will typically include:

A confirmation message or status code indicating the success or failure of the operation.
\n
Any additional data relevant to the KYC sharing process, if applicable.
\n

Notes

Ensure that the shareToken is valid and correctly formatted as a JWT before making the request.
\n
This endpoint is critical for businesses that need to comply with regulatory requirements regarding customer identity verification.
\n
Handle the response appropriately to manage any errors or confirmations returned by the API.
\n

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\n

Endpoint Description

This endpoint allows users to share a token that is typically used for Know Your Customer (KYC) processes. The shared token is essential for verifying user identity and facilitating secure transactions.

HTTP Method

POST

Request URL

https://my.kyrrex.mt/api/v1/business/kyc/shared_token

Request Parameters

The request body must be sent in JSON format and should include the following parameter:

shareToken (string): A JWT (JSON Web Token) that contains encoded information necessary for KYC verification. This token is used to authenticate the user and should be securely generated and managed.

Example Request Body

{\n  \"shareToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6Ik ...\"\n}\n\n

Expected Response Format

Upon successful processing of the request, the API will return a response in JSON format. The response typically includes:

A success message indicating that the token has been successfully shared.
\n
Additional data related to the KYC process, if applicable.
\n

Additional Notes

Ensure that the shareToken is valid and has not expired before making the request.
\n
This endpoint is crucial for businesses that need to comply with KYC regulations and ensure the authenticity of their users.
\n
Always handle the token securely and avoid exposing it in public or unsecured environments.
\n

By utilizing this endpoint, businesses can streamline their KYC processes and enhance their security protocols.

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

Generate Token for KYB (Know Your Business)

This endpoint allows users to generate a token required for the Know Your Business (KYB) process. The token is essential for initiating and managing business verification procedures.

Request

Method: POST
\n
Endpoint: https://my.kyrrex.mt/api/v1/business/kyb/generate_token
\n

Input Parameters

The request body must be sent in application/x-www-form-urlencoded format and should include the needed parameters.

Response

Upon a successful request, the server will respond with a JSON object containing the following structure:

{\n  \"token\": \"string\",\n  \"expires_in\": \"integer\",\n  \"status\": \"string\"\n}\n\n

token: A string representing the generated token.
\n
expires_in: An integer indicating the duration (in seconds) until the token expires.
\n
status: A string indicating the status of the token generation process.
\n

Ensure to handle the response appropriately to utilize the generated token for subsequent KYB operations.

Generate Web Link for KYB

This endpoint allows you to generate a web link for Know Your Business (KYB) verification. It is useful for businesses that need to collect and verify information from their clients or partners.

HTTP Method

POST

Endpoint

https://my.kyrrex.mt/api/v1/business/kyb/generate_web_link

Expected Responses

200 OK: The request was successful, and a web link has been generated. The response will contain the generated link and any relevant metadata.
\n
400 Bad Request: The request was malformed or missing required parameters. The response will include an error message detailing the issue.
\n
500 Internal Server Error: An unexpected error occurred on the server. The response will provide a general error message.
\n

Example Request

POST https://my.kyrrex.mt/api/v1/business/kyb/generate_web_link\nContent-Type: application/x-www-form-urlencoded\nparameter1=value1&parameter2=value2\n\n

Notes

Ensure that all required parameters are included in the request to avoid a 400 error.
\n
The generated web link can be used to facilitate the KYB process with your clients.
\n

Get Legal Entity Information

This endpoint retrieves detailed information about legal entities for Know Your Business (KYB) compliance.

Request Method

GET

Endpoint

https://my.kyrrex.mt/api/v1/business/kyb/legal_entities/info

Request Parameters

This endpoint does not require any additional parameters in the request.

Expected Response Format

The response will be in JSON format and will include details about the legal entities. The structure of the response may include keys such as:

id: Unique identifier for the legal entity.
\n
name: Name of the legal entity.
\n
registration_number: Official registration number of the entity.
\n
status: Current status of the legal entity.
\n

Ensure to handle the response appropriately based on the expected structure.

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

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

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/:provider_id/customers","description":"

Add Customer for Fiat Provider

This endpoint allows you to register a customer under a specific fiat provider. It is designed to facilitate the onboarding of customers by collecting essential information that can be used for verification and compliance purposes.

Request Body

The request body must contain the following parameters:

provider_id (string) - The ID of the fiat provider. This is a required field that identifies the provider under which the customer is being registered. Example: \"mmeur\".

Response

Upon successful registration, the response will be a JSON object containing the following properties:

address (string) - The address of the customer.
\n
city (string) - The city where the customer resides.
\n
country_id (integer) - The ID representing the customer's country.
\n
country_of_incorporation_id (nullable integer) - The ID representing the country of incorporation, if applicable.
\n
dob (string) - The date of birth of the customer.
\n
email (string) - The email address of the customer.
\n
first_name (string) - The first name of the customer.
\n
last_name (string) - The last name of the customer.
\n
level_info (object) - An object containing:
\n
- state (string) - The state of the customer's verification level.
  \n
- level_name (string) - The name of the verification level.
  \n
\n
phone (nullable string) - The phone number of the customer.
\n
place_of_birth_id (nullable integer) - The ID representing the place of birth, if applicable.
\n
postcode (string) - The postal code of the customer's address.
\n
terms_accepted (boolean) - Indicates whether the customer has accepted the terms and conditions.
\n
verification_status (string) - The current status of the customer's verification process.
\n

Example Response:

{\n    \"address\": \"\",\n    \"city\": \"\",\n    \"country_id\": 0,\n    \"country_of_incorporation_id\": null,\n    \"dob\": \"\",\n    \"email\": \"\",\n    \"first_name\": \"\",\n    \"last_name\": \"\",\n    \"level_info\": {\n        \"state\": \"\",\n        \"level_name\": \"\"\n    },\n    \"phone\": null,\n    \"place_of_birth_id\": null,\n    \"postcode\": \"\",\n    \"terms_accepted\": true,\n    \"verification_status\": \"\"\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 \"instrument\": \"sepa_iframe\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.mt/api/v1/business/fiat/providers/:provider_id/instruments/bank_transfers","description":"

Register Bank Transfer Instrument

This endpoint registers a bank transfer instrument for a specified fiat provider in the Kyrrex Business API. It enables businesses to configure payment methods for SEPA/SEPA_IFRAME (Single Euro Payments Area) bank transfers, allowing customers to deposit or withdraw funds using bank transfer instruments.

Endpoint Details

HTTP Method: POST

URL: https://my.kyrrex.mt/api/v1/business/fiat/providers/:provider_id/instruments/bank_transfers

Content-Type: application/json

Path Parameters

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

Parameter	Type	Required	Description	Example Values
`provider_id`	string	Yes	The unique identifier for the fiat provider	`veur`, cjeur

Request Body

The request body must be in JSON format and include the instrument type to register.

Schema

{\n  \"instrument\": \"sepa_iframe\"\n}\n\n

Parameters

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

Field	Type	Required	Description	Possible Values
`instrument`	string	Yes	The type of bank transfer instrument to register	`sepa_iframe`, `sepa`

Example Request Body

{\n  \"instrument\": \"sepa_iframe\"\n}\n\n

Response

Success Response (200 OK)

When the bank transfer instrument is successfully registered, the API returns a success response with the instrument details.

Status Code: 200 OK

Response Format: JSON

Notes

Ensure all authentication headers are properly configured before making requests
\n
The provider_id must correspond to an existing fiat provider in your business account
\n
Different instrument types (sepa_iframe sepa_tag) may offer different integration methods for bank transfers
\n
Variables like https://my.kyrrex.mt, ab6bd60a0a26d714d2dcc4827231218a9548f5cb, {{api_sign}}, and {{api_key}} should be configured in your Postman environment
\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/:provider_id/customers","description":"

Retrieve Customer Registration Status

This endpoint retrieves the registration status of a customer for a specific provider. It is useful for checking whether a customer has completed their registration process and to understand the current state of their registration.

Request

Method: GET
\n
URL: https://my.kyrrex.mt/api/v1/business/fiat/:provider_id/customers
\n
Path Parameter:
\n
- provider_id (string): The unique identifier for the provider whose customer registration status is being queried.
\n
Request Body: This request does not contain a request body.
\n

Response

The response for this request is a JSON object that includes the following fields:

provider_id (string): The ID of the provider associated with the customer.
\n
state (string): The overall state of the customer registration.
\n
instruments (object): An object containing the registration status for various instruments:
\n
- card_s (object): An object representing the card instrument with the following sub-field:
  \n
  - state (string): The state of the card instrument.
  \n
\n

This structure provides a comprehensive overview of the customer's registration status and the state of their associated instruments.

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 available for fiat deposits. It provides information on various deposit methods including card and bank transfer options.

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 details about the available fiat deposit providers and their associated instruments. The response schema includes the following properties:

card (object)
\n
- card_s (array of objects)
  \n
  - name (string): The name of the card provider.
    \n
  - provider_id (string): Unique identifier for the card provider.
    \n
  - currencies (array of strings): List of currencies supported by the card provider.
    \n
  \n
\n
bank_transfer (object)
\n
- sepa (array of objects)
  \n
  - name (string): The name of the bank transfer provider.
    \n
  - provider_id (string): Unique identifier for the bank transfer provider.
    \n
  - currencies (array of strings): List of currencies supported by the bank transfer provider.
    \n
  \n
- sepa_iframe (array of objects)
  \n
  - name (string): The name of the bank transfer provider for iframe integration.
    \n
  - provider_id (string): Unique identifier for the iframe bank transfer provider.
    \n
  - currencies (array of strings): List of currencies supported by the iframe bank transfer provider.
    \n
  \n
\n

An example response for this request is:

{\n  \"card\": {\n    \"card_s\": [\n      {\n        \"name\": \"\",\n        \"provider_id\": \"\",\n        \"currencies\": [\"\"]\n      }\n    ]\n  },\n  \"bank_transfer\": {\n    \"sepa\": [\n      {\n        \"name\": \"\",\n        \"provider_id\": \"\",\n        \"currencies\": [\"\"]\n      }\n    ],\n    \"sepa_iframe\": [\n      {\n        \"name\": \"\",\n        \"provider_id\": \"\",\n        \"currencies\": [\"\"]\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"}],"url":"https://my.kyrrex.mt/api/v1/business/fiat/providers/withdrawals","description":"

Retrieve Withdrawal Providers for Fiat Transactions

This endpoint allows users to retrieve a list of available withdrawal providers for fiat transactions. The response includes information about different withdrawal methods such as card and bank transfer options.

Request

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

Response Structure

The response will return a JSON object containing details about the withdrawal providers. The structure of the response is as follows:

card: An object that contains information regarding card withdrawal providers.
\n
- card_s: An array of objects, each representing a card provider with the following properties:
  \n
  - name: The name of the card provider.
    \n
  - provider_id: A unique identifier for the card provider.
    \n
  - currencies: An array of currency codes supported by the card provider.
    \n
  \n
\n
bank_transfer: An object that contains information regarding bank transfer withdrawal providers.
\n
- sepa: An array of objects representing SEPA bank transfer providers, each with the following properties:
  \n
  - name: The name of the SEPA provider.
    \n
  - provider_id: A unique identifier for the SEPA provider.
    \n
  - currencies: An array of currency codes supported by the SEPA provider.
    \n
  \n
- sepa_iframe: An array of objects representing SEPA bank transfer providers that support iframe integration, each with the same properties as above.
  \n
\n

Example Response

{\n  \"card\": {\n    \"card_s\": [\n      {\n        \"name\": \"\",\n        \"provider_id\": \"\",\n        \"currencies\": [\"\"]\n      }\n    ]\n  },\n  \"bank_transfer\": {\n    \"sepa\": [\n      {\n        \"name\": \"\",\n        \"provider_id\": \"\",\n        \"currencies\": [\"\"]\n      }\n    ],\n    \"sepa_iframe\": [\n      {\n        \"name\": \"\",\n        \"provider_id\": \"\",\n        \"currencies\": [\"\"]\n      }\n    ]\n  }\n}\n\n

Summary

This endpoint is essential for users looking to understand the available fiat withdrawal options, including both card and bank transfer methods, along with the currencies supported by each provider.

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":"{\r\n \"instrument\": \"card_s\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.mt/api/v1/business/fiat/providers/:provider_id/instruments/cards","description":"

Create Card Instrument

This endpoint is used only once to create a card instrument — NEW CARD — for a specific fiat provider.

The returned instrument UID is then used exclusively during a deposit flow, where the user enters their actual card details.

After the deposit is successfully processed, the system automatically saves this card and adds it to the user’s list of cards.

This endpoint does not attach an existing card — it only initializes a placeholder instrument (“NEW CARD”).

Endpoint

POST
https://my.kyrrex.mt/api/v1/business/fiat/providers/:provider_id/instruments/cards

Path Parameter

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

Name	Type	Description
`provider_id`	string	Identifier of the fiat provider for which the NEW CARD instrument is created. Must reference an existing provider.

Request Body

Body must be JSON and contain:

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

Field	Type	Description
`instrument`	string	Must be `\"card_s\"`. Defines that a NEW CARD instrument should be created.

Example

{\n  \"instrument\": \"card_s\"\n}\n\n

Response

Upon success the API returns:

\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
`status`	boolean	Indicates whether the instrument was successfully initialized.
`request_id`	string	Unique identifier for tracking the request. May be empty.
`instrument_state`	string	Current state of the created instrument (initial placeholder state).

Example Response

{\n  \"status\": true,\n  \"request_id\": \"\",\n  \"instrument_state\": \"\"\n}\n\n

Notes

provider_id must be valid.
\n
The only correct instrument for this flow is \"card_s\".
\n
This endpoint does not store card details; it only initializes an instrument placeholder.
\n
Correct handling of the returned UID is mandatory for deposits involving card registration.
\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":"

Get Card Instruments by Provider

This endpoint returns the list of card instruments for a given fiat provider.
The first item in the list is the special placeholder instrument — NEW CARD****.

This NEW CARD has its own UID, and this UID must be used when the user wants to make a deposit with a card that is not yet saved in the system.

During the deposit flow, the user enters their actual card details, and after a successful deposit, the system automatically adds the new card to the list of saved card instruments.

Endpoint

GET
https://my.kyrrex.mt/api/v1/business/fiat/providers/:provider_id/instruments/cards

Path Parameter

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

Name	Type	Description
`provider_id`	string	Identifier of the fiat provider whose card instruments should be retrieved.

Response

The response contains pagination details and a list of instruments.

Response 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

Field	Type	Description
`limit`	integer	Max number of items per response.
`total_count`	integer	Total number of instruments available.
`per_page`	integer	Items per page.
`total_pages`	integer	Total number of pages.
`page`	integer	Current page.
`prev_page`	integer	null
`next_page`	integer	null
`items`	array	List of card instruments.

Each item includes:

\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
`uid`	string	Unique identifier of the card instrument. For the first item (`NEW CARD`), this UID is used when performing deposit with a new card.
`type`	string	Type of instrument (e.g., `\"card_s\"`).
`provider_id`	string	Provider ID.
`name`	string	null
`currency`	string	The card currency.
`expired_at`	string	null
`tag`	string	null
`address`	string	Address associated with the instrument.
`fiat_details`	object	Bank-related fiat metadata.

Important Logic — NEW CARD

The first item in the items array is always the NEW CARD placeholder.
\n
Its uid is used only when performing a deposit with a new card that is not yet saved.
\n
After a successful deposit using NEW CARD:
\n
- The system automatically saves this card.
  \n
- It appears in the list of card instruments on subsequent calls.
  \n
\n
If the user already has saved cards, they will appear after the NEW CARD placeholder.
\n

Example Request

GET https://my.kyrrex.mt/api/v1/business/fiat/providers/creur/instruments/cards\n\n

Important Notes

provider_id must correspond to an existing fiat provider.
\n
If no instruments exist yet for this provider, the list will still include the NEW CARD placeholder.
\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/deposits/fees?instrument=card&provider_id=cheur\n","description":"

Fetch Deposit Commission Fee

This endpoint makes an HTTP GET request to https://my.kyrrex.mt/api/v1/business/fiat/deposits/fees to fetch the deposit commission fee for a specific instrument and provider.

Request Parameters

instrument: (query parameter) Specifies the instrument for which the deposit commission fee is to be fetched.
\n
provider_id: (query parameter) Specifies the provider ID for which the deposit commission fee is to be fetched.
\n

Response

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

{\n  \"dynamic\": \"\",\n  \"static\": \"\",\n  \"min_amount\": \"\"\n}\n\n

This schema represents the structure of the response object with keys dynamic, static, and min_amount.

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/deposits/fees/estimate?instrument=card&provider_id=creur&amount=10.00","description":"

Get Estimated Fee for Deposits

Request Parameters

instrument (string) - The type of instrument for the deposit.
\n
provider_id (string) - The ID of the provider.
\n
amount (string) - The amount for which the deposit fee is to be estimated.
\n

Example

GET https://my.kyrrex.mt/api/v1/business/fiat/deposits/fees/estimate?instrument=card&provider_id=creur&amount=10.00\n\n

Response

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

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

amount (string) - The amount for which the fee is estimated.
\n
fee (string) - The estimated fee for the deposit.
\n
total_amount (string) - The total amount including the fee.
\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=creur","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=creur","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 \"deposit_address_uid\": 7754,\n \"provider_id\": \"creur\",\n \"amount\": 10.00\n}","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.mt/api/v1/business/fiat/deposits","description":"

Create Fiat Deposit via Card

Overview

This endpoint initiates a fiat currency deposit transaction using a card payment method. When called, it processes the deposit request through integrated payment providers and returns a URL to a payment frame where the user must complete the card payment transaction.

Important: This is a two-step process - the API call creates the deposit intent and provides a payment frame URL, then the user must be redirected to that URL to complete the actual payment.

Example Headers:

Auth_token: ab6bd60a0a26d714d2dcc4827231218a9548f5cb\nAPISign: {{api_sign}}\nAPIKey: {{api_key}}\n\n

Request Body Parameters

The request body must be sent as JSON with the following parameters:

{\n  \"deposit_address_uid\": 7754,\n  \"provider_id\": \"creur\",\n  \"amount\": 10\n}\n\n

Parameters:

deposit_address_uid (integer, required)
\n
- The unique identifier for the deposit address where funds will be credited after successful payment
  \n
- Example: 7754
  \n
- This identifies the destination account/wallet for the deposit
  \n
\n
provider_id (string, required)
\n
- The payment provider identifier that will process the card transaction
  \n
- Example: \"creur\" for card EUR payments
  \n
\n
amount (number, required)
\n
- The deposit amount in the currency supported by the provider
  \n
- Must be a positive number
  \n
- Example: 10 (represents 10 units of the currency)
  \n
- Check provider-specific minimum and maximum limits
  \n
\n

Response Structure

A successful request returns:

Status: 200 OK

Response Body: Contains only two fields:

{\n  \"uuid\": \"fpc-12a0715d-d58e-4088-9e07-979b63c51248\",\n  \"frame_url\": \"https://domain.com/co/ee1cafbd-fa09-443e-a5f8-355d8690feea/91/1533/6a5c21aa-ea6b-4f21-9416-732541b316d7/1\"\n}\n\n

Response Fields:

uuid (string) - Unique identifier for this deposit transaction. Use this to track and reference the deposit.
\n
frame_url (string) - CRITICAL: The URL to the payment frame where the user must complete the card payment. This is the secure payment page hosted by the payment provider.
\n

Important Notes

Payment Frame Requirements:

Critical: The frame_url returned in the response MUST be used to complete the transaction. Without redirecting the user to this URL, the deposit cannot be completed.

Security Considerations:

The payment frame is hosted by the payment provider and handles sensitive card data securely
\n
The frame URL is typically time-limited and single-use
\n
Do not cache or reuse payment frame URLs
\n

Error Handling:

If the API call fails, no frame URL is generated
\n
If the user abandons the payment frame, monitor the transaction status via the uuid
\n
Implement timeout handling for users who don't complete payment
\n
Monitor webhook/callback endpoints for final transaction status
\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_s\",\n \"provider_id\": \"creur\",\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_s
\n
provider_id: creur
\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

Body:

{\n    \"payout_method\": \"card\",\n    \"instrument\": \"card\",\n    \"provider_id\": \"creur\",\n    \"amount\": 10.00,\n    \"currency\": \"EUR\",\n    \"withdrawal_address_uid\": 6822\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/instruments/bank_transfers?instrument=sepa_iframe","description":"

This endpoint retrieves the bank transfer instruments for a specific provider identified by \":provider_id\".

Request Description

Method: GET
\n
URL: https://my.kyrrex.mt/api/v1/business/fiat/providers/:provider_id/instruments/bank_transfers
\n

Response Structure

The response will include the following fields:

address (string): The address associated with the bank transfer instrument.
\n
currency (string): The currency of the bank transfer instrument.
\n
provider_id (string): The ID of the provider associated with the bank transfer instrument.
\n
expired_at (string): The expiration date of the bank transfer instrument.
\n
fiat_details (object): Details related to the bank transfer instrument in fiat currency, including:
\n
- bank_recipient (string): The recipient's name for the bank transfer.
  \n
- bank_name (string): The name of the bank associated with the bank transfer instrument.
  \n
- bank_address (string): The address of the bank associated with the bank transfer instrument.
  \n
- bank_bic (string): The Bank Identifier Code (BIC) associated with the bank transfer instrument.
  \n
- bank_payment_details (string): Additional payment details for the bank transfer instrument.
  \n
\n
name (string): The name associated with the bank transfer instrument.
\n
tag (string): The tag associated with the bank transfer instrument.
\n
type (string): The type of the bank transfer instrument.
\n
uid (integer): The unique identifier associated with the bank transfer instrument.
\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/deposits?provider_id=creur¤cy=eur&status=done","description":"

Get Fiat Deposits

This endpoint retrieves a list of deposit transactions for fiat currency.

Request Parameters

provider_id (query parameter) - The ID of the deposit provider.
\n
currency (query parameter) - The currency for the deposit transactions.
\n
status (query parameter) - The status of the deposit transactions.
\n

Response Body

The response contains an array of deposit transaction objects, including details such as transaction ID, amount, currency, timestamp, and status.

This endpoint makes an HTTP GET request to https://my.kyrrex.mt/api/v1/business/fiat/deposits to retrieve a list of deposit transactions based on the provided parameters.

Parameters

provider_id (query parameter): The identifier of the provider for the deposit transactions.
\n
currency (query parameter): The currency for the deposit transactions.
\n
status (query parameter): The status of the deposit transactions.
\n

Response

The response of this request is documented as a JSON schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"deposit_transactions\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"transaction_id\": {\n            \"type\": \"string\"\n          },\n          \"amount\": {\n            \"type\": \"number\"\n          },\n          \"currency\": {\n            \"type\": \"string\"\n          },\n          \"status\": {\n            \"type\": \"string\"\n          },\n          \"timestamp\": {\n            \"type\": \"string\",\n            \"format\": \"date-time\"\n          }\n        },\n        \"required\": [\"transaction_id\", \"amount\", \"currency\", \"status\", \"timestamp\"]\n      }\n    }\n  },\n  \"required\": [\"deposit_transactions\"]\n}\n\n

This JSON schema defines the structure of the response object, including the array of deposit transactions with their respective properties such as transaction ID, amount, currency, status, and timestamp.

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=veur¤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 Fiat Permissions

This endpoint retrieves the permissions associated with a specific fiat provider. It is useful for understanding what operations can be performed with the provided fiat instrument.

Request

Method: GET
\n
URL: https://my.kyrrex.mt/api/v1/business/fiat/permissions
\n
Query Parameters:
\n
- provider_id (required): The unique identifier for the fiat provider. In this case, an example value is creur.
\n

Response

The response will be a JSON array containing permission objects. Each object in the array has the following structure:

instrument_id: The identifier for the specific instrument.
\n
operation_id: The identifier for the operation that can be performed.
\n
status: The current status of the permission.
\n

Example Response:

[\n  {\n    \"instrument_id\": \"\",\n    \"operation_id\": \"\",\n    \"status\": \"\"\n  }\n]\n\n

This response indicates the permissions available for the specified fiat provider, allowing the consumer to understand what actions are permitted.

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

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

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

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

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":"662cb653-0e33-49cd-b399-813e919d9d57","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":"cd7f4073-094f-43fc-906b-1e9ad815956c"}],"id":"50ebffd9-0847-4f30-bc2e-3c2d03b4c46d","_postman_id":"50ebffd9-0847-4f30-bc2e-3c2d03b4c46d","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"30cf573a-c182-40d5-a0c9-80d82e637d57","id":"30cf573a-c182-40d5-a0c9-80d82e637d57","name":"Kyrrex Malta Business","type":"collection"}}},{"name":"settings","item":[{"name":"currencies list","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"4434d2eb-9237-4b6d-ab27-93d3f8426968"}}],"id":"49055960-7469-4000-84bf-8e2bd31fdcef","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/settings/currencies","description":"

Retrieve Currencies Settings

This endpoint allows you to retrieve the settings for currencies.

Request

Request Body

This endpoint does not require a request body.

Query Parameters

This endpoint does not require any query parameters.

Response

The response will be a JSON array of objects representing the available currencies settings. Each object in the array will have the following properties:

code: The currency code.
\n
dchains: An array of objects representing the dchains for the currency.
\n
- dcode: The dchain code.
  \n
- display_name: The display name for the dchain.
  \n
- account: An object representing the account settings for the dchain.
  \n
  - min_account_balance: The minimum account balance.
    \n
  - max_account_balance: The maximum account balance.
    \n
  \n
- deposit: An object representing the deposit settings for the dchain.
  \n
  - static_fee: The static fee for deposits.
    \n
  - dynamic_fee: The dynamic fee for deposits.
    \n
  - aml_fee: The AML fee for deposits.
    \n
  - min_amount: The minimum deposit amount.
    \n
  - max_amount: The maximum deposit amount.
    \n
  \n
- withdraw: An object representing the withdraw settings for the dchain.
  \n
  - static_fee: The static fee for withdrawals.
    \n
  - dynamic_fee: The dynamic fee for withdrawals.
    \n
  - aml_fee: The AML fee for withdrawals.
    \n
  - min_amount: The minimum withdrawal amount.
    \n
  - max_amount: The maximum withdrawal amount.
    \n
  \n
\n
name: The name of the currency.
\n
precision: The precision of the currency.
\n
type: The type of the currency.
\n

Example:

[\n  {\n    \"code\": \"\",\n    \"dchains\": [\n      {\n        \"dcode\": \"\",\n        \"display_name\": \"\",\n        \"account\": {\n          \"min_account_balance\": \"\",\n          \"max_account_balance\": \"\"\n        },\n        \"deposit\": {\n          \"static_fee\": \"\",\n          \"dynamic_fee\": \"\",\n          \"aml_fee\": \"\",\n          \"min_amount\": \"\",\n          \"max_amount\": \"\"\n        },\n        \"withdraw\": {\n          \"static_fee\": \"\",\n          \"dynamic_fee\": \"\",\n          \"aml_fee\": \"\",\n          \"min_amount\": \"\",\n          \"max_amount\": \"\"\n        }\n      }\n    ],\n    \"name\": \"\",\n    \"precision\": 0,\n    \"type\": \"\"\n  }\n]\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"30cf573a-c182-40d5-a0c9-80d82e637d57","id":"30cf573a-c182-40d5-a0c9-80d82e637d57","name":"Kyrrex Malta Business","type":"collection"}},"urlObject":{"path":["api","v1","business","settings","currencies"],"host":["https://my.kyrrex.mt"],"query":[],"variable":[]}},"response":[{"id":"89c0a2de-1441-4bf0-bc67-c7af867a7cb9","name":"currencies 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/settings/currencies"},"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:47: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/\"1601-c79ntkgWzz52KCQu9/Lh50AAwLY\""},{"key":"Vary","value":"accept-encoding"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 4a0b7683a1d33d6d186965e831f2de96.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"FRA56-P7"},{"key":"X-Amz-Cf-Id","value":"qAn4m9Yiyvw1YjfdhoygxtpG77vFSCXcFJME9U09B_WycHeoCTCGew=="}],"cookie":[],"responseTime":null,"body":"[\n {\n \"code\": \"btc\",\n \"dchains\": [\n {\n \"dcode\": \"btc\",\n \"display_name\": \"Bitcoin\",\n \"account\": {\n \"min_account_balance\": \"0.0\",\n \"max_account_balance\": \"0.0\"\n },\n \"deposit\": {\n \"static_fee\": \"0.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"0.0005\",\n \"max_amount\": \"0.0\"\n },\n \"withdraw\": {\n \"static_fee\": \"0.0005\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.0001\",\n \"min_amount\": \"0.0005\",\n \"max_amount\": \"0.0\"\n }\n }\n ],\n \"name\": \"Bitcoin\",\n \"precision\": 8,\n \"type\": \"crypto\"\n },\n {\n \"code\": \"ltc\",\n \"dchains\": [\n {\n \"dcode\": \"ltc\",\n \"display_name\": \"Litecoin\",\n \"account\": {\n \"min_account_balance\": \"0.0\",\n \"max_account_balance\": \"0.0\"\n },\n \"deposit\": {\n \"static_fee\": \"0.01\",\n \"dynamic_fee\": \"0.02\",\n \"aml_fee\": \"0.01\",\n \"min_amount\": \"0.002\",\n \"max_amount\": \"0.0\"\n },\n \"withdraw\": {\n \"static_fee\": \"0.05\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.01\",\n \"min_amount\": \"0.1\",\n \"max_amount\": \"0.0\"\n }\n }\n ],\n \"name\": \"ltc\",\n \"precision\": 8,\n \"type\": \"crypto\"\n },\n {\n \"code\": \"eur\",\n \"dchains\": [\n {\n \"dcode\": \"cjeur\",\n \"display_name\": \"Clear Junction EUR\",\n \"account\": {\n \"min_account_balance\": \"0.0\",\n \"max_account_balance\": \"0.0\"\n },\n \"deposit\": {\n \"static_fee\": \"1.0\",\n \"dynamic_fee\": \"2.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"10.0\",\n \"max_amount\": \"0.0\"\n },\n \"withdraw\": {\n \"static_fee\": \"1.0\",\n \"dynamic_fee\": \"2.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"10.0\",\n \"max_amount\": \"0.0\"\n }\n },\n {\n \"dcode\": \"freur\",\n \"display_name\": \"Fiat Republic\",\n \"account\": {\n \"min_account_balance\": \"0.0\",\n \"max_account_balance\": \"0.0\"\n },\n \"deposit\": {\n \"static_fee\": \"0.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"1.0\",\n \"max_amount\": \"0.0\"\n },\n \"withdraw\": {\n \"static_fee\": \"0.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"2.0\",\n \"max_amount\": \"0.0\"\n }\n },\n {\n \"dcode\": \"mmeur\",\n \"display_name\": \"Merge\",\n \"account\": {\n \"min_account_balance\": \"0.0\",\n \"max_account_balance\": \"0.0\"\n },\n \"deposit\": {\n \"static_fee\": \"0.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"1.0\",\n \"max_amount\": \"0.0\"\n },\n \"withdraw\": {\n \"static_fee\": \"0.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"2.0\",\n \"max_amount\": \"0.0\"\n }\n },\n {\n \"dcode\": \"cheur\",\n \"display_name\": \"Checkout EUR\",\n \"account\": {\n \"min_account_balance\": \"0.0\",\n \"max_account_balance\": \"0.0\"\n },\n \"deposit\": {\n \"static_fee\": \"0.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"10.0\",\n \"max_amount\": \"10000.0\"\n },\n \"withdraw\": {\n \"static_fee\": \"0.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"10.0\",\n \"max_amount\": \"0.0\"\n }\n },\n {\n \"dcode\": \"veur\",\n \"display_name\": \"VOLT Eur\",\n \"account\": {\n \"min_account_balance\": \"0.0\",\n \"max_account_balance\": \"0.0\"\n },\n \"deposit\": {\n \"static_fee\": \"0.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"1.0\",\n \"max_amount\": \"0.0\"\n },\n \"withdraw\": {\n \"static_fee\": \"0.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"3.0\",\n \"max_amount\": \"0.0\"\n }\n }\n ],\n \"name\": \"eur\",\n \"precision\": 2,\n \"type\": \"fiat\"\n },\n {\n \"code\": \"eth\",\n \"dchains\": [\n {\n \"dcode\": \"eth\",\n \"display_name\": \"Ethereum\",\n \"account\": {\n \"min_account_balance\": \"0.0\",\n \"max_account_balance\": \"0.0\"\n },\n \"deposit\": {\n \"static_fee\": \"0.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.002\",\n \"min_amount\": \"0.001\",\n \"max_amount\": \"0.0\"\n },\n \"withdraw\": {\n \"static_fee\": \"0.007\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.003\",\n \"min_amount\": \"0.01\",\n \"max_amount\": \"0.0\"\n }\n }\n ],\n \"name\": \"eth\",\n \"precision\": 8,\n \"type\": \"crypto\"\n },\n {\n \"code\": \"xlm\",\n \"dchains\": [\n {\n \"dcode\": \"xlm\",\n \"display_name\": \"Stellar\",\n \"account\": {\n \"min_account_balance\": \"0.0\",\n \"max_account_balance\": \"0.0\"\n },\n \"deposit\": {\n \"static_fee\": \"3.0\",\n \"dynamic_fee\": \"0.01\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"5.0\",\n \"max_amount\": \"0.0\"\n },\n \"withdraw\": {\n \"static_fee\": \"5.0\",\n \"dynamic_fee\": \"0.01\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"10.0\",\n \"max_amount\": \"0.0\"\n }\n }\n ],\n \"name\": \"xlm\",\n \"precision\": 8,\n \"type\": \"crypto\"\n },\n {\n \"code\": \"usdc\",\n \"dchains\": [\n {\n \"dcode\": \"usdc\",\n \"display_name\": \"USD COIN ERC20\",\n \"account\": {\n \"min_account_balance\": \"0.0\",\n \"max_account_balance\": \"0.0\"\n },\n \"deposit\": {\n \"static_fee\": \"0.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"10.0\",\n \"max_amount\": \"0.0\"\n },\n \"withdraw\": {\n \"static_fee\": \"5.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"10.0\",\n \"max_amount\": \"0.0\"\n }\n }\n ],\n \"name\": \"USD COIN ERC20\",\n \"precision\": 8,\n \"type\": \"crypto\"\n },\n {\n \"code\": \"xrp\",\n \"dchains\": [\n {\n \"dcode\": \"xrp\",\n \"display_name\": \"Ripple\",\n \"account\": {\n \"min_account_balance\": \"0.0\",\n \"max_account_balance\": \"0.0\"\n },\n \"deposit\": {\n \"static_fee\": \"0.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"0.2\",\n \"max_amount\": \"0.0\"\n },\n \"withdraw\": {\n \"static_fee\": \"10.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"20.0\",\n \"max_amount\": \"0.0\"\n }\n }\n ],\n \"name\": \"xrp\",\n \"precision\": 6,\n \"type\": \"crypto\"\n },\n {\n \"code\": \"bch\",\n \"dchains\": [\n {\n \"dcode\": \"bch\",\n \"display_name\": \"Bitcoin Cash\",\n \"account\": {\n \"min_account_balance\": \"0.0\",\n \"max_account_balance\": \"0.0\"\n },\n \"deposit\": {\n \"static_fee\": \"0.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"0.005\",\n \"max_amount\": \"100.0\"\n },\n \"withdraw\": {\n \"static_fee\": \"0.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"0.017\",\n \"max_amount\": \"0.0\"\n }\n }\n ],\n \"name\": \"Bitcoin Cash\",\n \"precision\": 8,\n \"type\": \"crypto\"\n },\n {\n \"code\": \"trx\",\n \"dchains\": [\n {\n \"dcode\": \"trx\",\n \"display_name\": \"Tron\",\n \"account\": {\n \"min_account_balance\": \"0.0\",\n \"max_account_balance\": \"0.0\"\n },\n \"deposit\": {\n \"static_fee\": \"5.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"20.0\",\n \"max_amount\": \"0.0\"\n },\n \"withdraw\": {\n \"static_fee\": \"5.0\",\n \"dynamic_fee\": \"0.1\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"40.0\",\n \"max_amount\": \"0.0\"\n }\n }\n ],\n \"name\": \"Tron\",\n \"precision\": 6,\n \"type\": \"crypto\"\n },\n {\n \"code\": \"usdt\",\n \"dchains\": [\n {\n \"dcode\": \"trc20usdt\",\n \"display_name\": \"TRC20\",\n \"account\": {\n \"min_account_balance\": \"0.0\",\n \"max_account_balance\": \"0.0\"\n },\n \"deposit\": {\n \"static_fee\": \"0.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"0.0\",\n \"min_amount\": \"2.0\",\n \"max_amount\": \"0.0\"\n },\n \"withdraw\": {\n \"static_fee\": \"2.0\",\n \"dynamic_fee\": \"0.01\",\n \"aml_fee\": \"1.0\",\n \"min_amount\": \"11.0\",\n \"max_amount\": \"0.0\"\n }\n },\n {\n \"dcode\": \"usdterc20\",\n \"display_name\": \"ERC20\",\n \"account\": {\n \"min_account_balance\": \"0.0\",\n \"max_account_balance\": \"0.0\"\n },\n \"deposit\": {\n \"static_fee\": \"0.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"1.0\",\n \"min_amount\": \"10.0\",\n \"max_amount\": \"0.0\"\n },\n \"withdraw\": {\n \"static_fee\": \"25.0\",\n \"dynamic_fee\": \"0.0\",\n \"aml_fee\": \"1.0\",\n \"min_amount\": \"16.0\",\n \"max_amount\": \"0.0\"\n }\n }\n ],\n \"name\": \"usdt\",\n \"precision\": 10,\n \"type\": \"crypto\"\n }\n]"}],"_postman_id":"49055960-7469-4000-84bf-8e2bd31fdcef"},{"name":"markets list","id":"642f3451-b10d-4b71-bf65-ba2c04f3caab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v1/business/settings/markets","description":"

Get Market Settings

Method: GET
URL: https://my.kyrrex.mt/api/v1/business/settings/markets

This endpoint retrieves the market settings for the business. It provides detailed information about various market parameters that are essential for trading operations.

Request Parameters

This endpoint does not require any input parameters in the request body. However, you must ensure that the appropriate authentication token is included in the headers.

Response Structure

The response will be a JSON array containing objects that represent the market settings. Each object may include the following fields:

active (boolean): Indicates if the market is currently active.
\n
base_precision (integer): The precision of the base currency.
\n
base_unit (string): The unit of the base currency.
\n
maker_fee (string): The fee charged to makers in the market.
\n
market (string): The identifier for the market.
\n
min_amount (string): The minimum amount required for trades in this market.
\n
min_volume (string): The minimum volume required for trades in this market.
\n
price_precision (integer): The precision of the price in the market.
\n
quote_precision (integer): The precision of the quote currency.
\n
quote_unit (string): The unit of the quote currency.
\n
taker_fee (string): The fee charged to takers in the market.
\n

Possible Error Responses

401 Unauthorized: Returned if the authentication token is missing or invalid.
\n
404 Not Found: Returned if the requested market settings do not exist.
\n
500 Internal Server Error: Returned if there is a server issue while processing the request.
\n

Make sure to handle these error responses appropriately in your application.

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":"creur"},{"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":"a7a7e7dd-1748-433b-9cd6-f13b73bddb45","name":"fees estimate","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.mt/api/v1/business/advanced_exchanges/estimate?instrument=card_s&provider_id=creur&fiat_amount=100&crypto_amount=10","host":["https://my.kyrrex.mt"],"path":["api","v1","business","advanced_exchanges","estimate"],"query":[{"key":"instrument","value":"card_s","description":"required"},{"key":"provider_id","value":"creur","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":"55b2126e-aa06-44f2-a081-f86776d2d8f9"},{"name":"exchange","id":"092d87b6-4838-48f3-9e7d-f40273807f82","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\": \"creur\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.mt/api/v1/business/advanced_exchanges","description":"

Advanced Exchanges

This endpoint allows you to initiate an advanced exchange request for business purposes, facilitating the conversion of fiat currency to cryptocurrency.

Request Body

The request body must be in JSON format and include the following parameters:

deposit_address_uid (integer): The unique identifier for the deposit address associated with the fiat currency.
\n
fiat_currency (string): The fiat currency you wish to exchange (e.g., EUR).
\n
crypto_asset (string): The cryptocurrency asset you want to receive in exchange (e.g., BTC).
\n
fiat_amount (number): The amount in fiat currency that you are exchanging.
\n
payment_method (string): The method of payment for the exchange (e.g., card).
\n
provider_id (string): The identifier for the provider facilitating the exchange.
\n

Response

Upon a successful request, the response will be in JSON format and may include:

frame_url (string): The URL for the advanced exchange request, which can be used to redirect or display the exchange process.
\n
uid (string): A unique identifier for the exchange request.
\n

Ensure that all parameters are correctly formatted and provided to avoid errors in processing the exchange request.

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":"27023048-18b1-480b-a7ef-bda6f9ed2af5","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":"d6c5cebb-b1ce-4b4c-bf91-2ab7de686b51"}],"id":"bf3fc24a-f0ea-4ec1-9d78-9a97a6f84d80","_postman_id":"bf3fc24a-f0ea-4ec1-9d78-9a97a6f84d80","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"30cf573a-c182-40d5-a0c9-80d82e637d57","id":"30cf573a-c182-40d5-a0c9-80d82e637d57","name":"Kyrrex Malta Business","type":"collection"}}},{"name":"swaps","item":[{"name":"list","id":"3d8e19c2-bb7e-44bf-92c9-bc4558837f73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v1/business/exchanges","description":"

Retrieve Exchanges

This endpoint allows you to retrieve a list of exchanges.

Request

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

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    \"prev_page\": {\n      \"type\": [\"integer\", \"null\"]\n    },\n    \"next_page\": {\n      \"type\": \"integer\"\n    },\n    \"items\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"amount\": {\n            \"type\": \"string\"\n          },\n          \"created\": {\n            \"type\": \"string\"\n          },\n          \"asset\": {\n            \"type\": \"string\"\n          },\n          \"executed\": {\n            \"type\": \"string\"\n          },\n          \"input_asset\": {\n            \"type\": \"string\"\n          },\n          \"output_amount\": {\n            \"type\": \"string\"\n          },\n          \"output_asset\": {\n            \"type\": \"string\"\n          },\n          \"state\": {\n            \"type\": \"string\"\n          },\n          \"uid\": {\n            \"type\": \"string\"\n          }\n        }\n      }\n    }\n  }\n}\n\n

allowed values - created_at/ id /state

\n","type":"text/plain"},"key":"sort_by","value":null}],"variable":[]}},"response":[{"id":"2c8f52d0-7ebc-47dd-9d92-09050be80b39","name":"list","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.mt/api/v1/business/exchanges","host":["https://my.kyrrex.mt"],"path":["api","v1","business","exchanges"],"query":[{"key":"page","value":null,"disabled":true},{"key":"per_page","value":null,"disabled":true},{"key":"input_asset","value":null,"disabled":true},{"key":"output_asset","value":null,"disabled":true},{"key":"state","value":null,"disabled":true},{"key":"from","value":null,"disabled":true},{"key":"to","value":null,"disabled":true},{"key":"sort","value":null,"disabled":true},{"key":"sort_by","value":null,"description":"allowed values - created_at/ id /state","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"total_count\": 25,\r\n\t\"per_page\": 2,\r\n\t\"total_pages\": 13,\r\n\t\"page\": 1,\r\n\t\"prev_page\": null,\r\n\t\"next_page\": 2,\r\n\t\"items\": [\r\n\t\t{\r\n\t\t\t\"amount\": \"0.00072279\",\r\n\t\t\t\"created\": \"2024-02-19T23:36:25.421Z\",\r\n\t\t\t\"asset\": \"btceur\",\r\n\t\t\t\"executed\": \"1.0\",\r\n\t\t\t\"input_asset\": \"btc\",\r\n\t\t\t\"output_amount\": \"34.0\",\r\n\t\t\t\"output_asset\": \"eur\",\r\n\t\t\t\"state\": \"done\",\r\n\t\t\t\"uid\": \"230-567216545007490\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"amount\": \"10.0\",\r\n\t\t\t\"created\": \"2024-02-19T23:33:13.281Z\",\r\n\t\t\t\"asset\": \"eurbtc\",\r\n\t\t\t\"executed\": \"1.0\",\r\n\t\t\t\"input_casset\": \"eur\",\r\n\t\t\t\"output_amount\": \"0.000208\",\r\n\t\t\t\"output_asset\": \"btc\",\r\n\t\t\t\"state\": \"done\",\r\n\t\t\t\"uid\": \"230-567216545007428\"\r\n\t\t}\r\n\t]\r\n}"}],"_postman_id":"3d8e19c2-bb7e-44bf-92c9-bc4558837f73"},{"name":"create","id":"a8c5aaaa-7810-44f3-a6cc-eaa3c96d0be5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"input_asset\": \"BTC\",\r\n \"output_asset\": \"USDT\",\r\n \"amount\": 0.5\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.mt/api/v1/business/exchanges","description":"

Exchange Assets

This endpoint allows you to exchange one asset for another.

Request Body

input_asset (string): The asset to be exchanged.
\n
output_asset (string): The desired asset to receive.
\n
amount (number): The amount of input asset to exchange.
\n

Response

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

amount (string): The amount of output asset received.
\n
created (string): The timestamp of the exchange creation.
\n
asset (string): The asset involved in the exchange.
\n
executed (string): The timestamp of when the exchange was executed.
\n
input_asset (string): The input asset for the exchange.
\n
output_amount (string): The amount of output asset received.
\n
output_asset (string): The output asset received.
\n
state (string): The state of the exchange.
\n
uid (string): The unique identifier for the exchange.
\n

JSON Schema for Response

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"amount\": { \"type\": \"string\" },\n    \"created\": { \"type\": \"string\" },\n    \"asset\": { \"type\": \"string\" },\n    \"executed\": { \"type\": \"string\" },\n    \"input_asset\": { \"type\": \"string\" },\n    \"output_amount\": { \"type\": \"string\" },\n    \"output_asset\": { \"type\": \"string\" },\n    \"state\": { \"type\": \"string\" },\n    \"uid\": { \"type\": \"string\" }\n  }\n}\n\n

Get Exchange Estimate

This endpoint retrieves an estimate for exchanging one asset to another based on the specified input and output assets along with the amount.

Request

input_asset (string, required): The input asset for the exchange.
\n
output_asset (string, required): The output asset for the exchange.
\n
amount (string, required): The amount of input asset to be exchanged.
\n

Response
The response will contain the following fields:

input
\n
- amount (string): The amount of input asset provided in the request.
  \n
- asset (string): The asset provided as input in the request.
  \n
- minimum_amount (string): The minimum amount of output asset that will be received in the exchange.
  \n
\n
output
\n
- amount (string): The amount of output asset that will be received in the exchange.
  \n
- asset (string): The asset that will be received in the exchange.
  \n
\n
rate (string): The exchange rate for the specified input and output assets.
\n

required

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

required

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

required

\n","type":"text/plain"},"key":"amount","value":null}],"variable":[]}},"response":[{"id":"1a310ee4-511b-49a8-9374-54bca0395d18","name":"estimate","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.mt/api/v1/business/exchanges/estimate?input_asset=usdt&output_asset=btc&amount=1000","host":["https://my.kyrrex.mt"],"path":["api","v1","business","exchanges","estimate"],"query":[{"key":"input_asset","value":"usdt","description":"required"},{"key":"output_asset","value":"btc","description":"required"},{"key":"amount","value":"1000","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\"input\": {\r\n\t\t\"amount\": \"1000.0\",\r\n\t\t\"asset\": \"usdt\",\r\n\t\t\"minimum_amount\": \"5.0\"\r\n\t},\r\n\t\"output\": {\r\n\t\t\"amount\": \"0.01538802\",\r\n\t\t\"asset\": \"btc\"\r\n\t},\r\n\t\"rate\": \"64985.6\"\r\n}"}],"_postman_id":"31f96576-ff76-4bf7-bfe5-fff113839486"}],"id":"936ceb5a-27f3-4108-8105-b87a7b677b16","_postman_id":"936ceb5a-27f3-4108-8105-b87a7b677b16","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"30cf573a-c182-40d5-a0c9-80d82e637d57","id":"30cf573a-c182-40d5-a0c9-80d82e637d57","name":"Kyrrex Malta Business","type":"collection"}}},{"name":"markets","item":[{"name":"list","id":"cb2193a0-8df3-45c8-b513-299fadf770c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v1/business/markets","description":"

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":"22ea9650-16b8-42d2-b529-5b3034e2c0a2","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":"4a95ac07-cbbc-4798-8e37-9aedfdf40aec"}],"id":"92a2e2c6-d79d-4e63-8ad8-e2898aa4fbe0","_postman_id":"92a2e2c6-d79d-4e63-8ad8-e2898aa4fbe0","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"30cf573a-c182-40d5-a0c9-80d82e637d57","id":"30cf573a-c182-40d5-a0c9-80d82e637d57","name":"Kyrrex Malta Business","type":"collection"}}},{"name":"webhooks","item":[],"id":"f6b36ec1-05f8-4ef4-b3ad-9e08fa6c35e0","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":"f6b36ec1-05f8-4ef4-b3ad-9e08fa6c35e0","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]},"isInherited":true,"source":{"_postman_id":"30cf573a-c182-40d5-a0c9-80d82e637d57","id":"30cf573a-c182-40d5-a0c9-80d82e637d57","name":"Kyrrex Malta Business","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth-Token"},{"key":"value","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"}]}},"event":[{"listen":"prerequest","script":{"id":"f42e233f-b31b-4b51-beda-089694c666d7","type":"text/javascript","packages":{},"requests":{},"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 => {"," const value = queryObj[key];"," const valueStr = Array.isArray(value) ? value.join(',') : value;"," return `${encodeURIComponent(key)}=${encodeURIComponent(valueStr)}`;"," }).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":"bdde9f0a-064f-4d2f-ad0a-bb52593418b0","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"base_url","value":"https://my.kyrrex.mt"},{"key":"access_key","value":""},{"key":"secret_key","value":""},{"key":"signature","value":""},{"key":"auth_token","value":"ab6bd60a0a26d714d2dcc4827231218a9548f5cb"},{"key":"master_access_key","value":""},{"key":"master_secret_key","value":""},{"key":"master_signature","value":""}]}

Introduction

Overview

1. Authentication Flow Overview

Step 1 — Owner-Level Authorization (Auth-Token)

Step 2 — Registration → Initial access_key / secret_key

Step 3 — Login to obtain session keys

Step 3 — Session Keys (Operational keys)

2. Required Headers

3. Request Signing Rules

Where:

GET requests

POST / PUT / PATCH / DELETE

4. Signature Generation

5. Complete Pre-request Script

6. Error Handling

Common causes:

8. Best Practices

9. Summary

Business API Verification Flow

1. KYC Verification (Individual Users)

1.1 Generate KYC Token

1.2 Generate KYC Web Link

1.3 Shared Token

1.4 Get KYC Levels

2. KYB Verification (Legal Entity)

2.1 Generate KYB Token

2.2 Generate KYB Web Link

2.3 Get Legal Entity Info

3. Business Logic Summary

KYC

KYB

5. Key Notes for Integrators

Prerequisites

1. The business must hold a valid Auth-Token

2. The user (member) must be created and registered

3. The user must be successfully logged in

4. All requests must be signed

Important:

Overview of the On-Ramp Flow

1. Provider Selection and Customer Registration

1.1 Retrieve available fiat providers

1.2 Register the customer with the selected provider

1.3 Check provider registration status

2. Registering the Deposit Instrument

2.1 Register SEPA / SEPA_IFRAME bank transfer instruments

2.2 Register Card_s instrument (Corefy)

2.2.1 Create the Card_s instrument

2.2.2 Retrieve all saved cards

2.3 Check instrument registration status

2.4 Retrieve bank transfer details (SEPA / SEPA_IFRAME)

3. Performing a Fiat Deposit

3.1 Retrieve general deposit fees

3.2 Estimate deposit fees for a specific amount

3.3 Execute Deposi

A) Corefy (Card_s):

B) Volt (SEPA_IFRAME)

C) Clear Junction / Fiat Republic (SEPA)

3.4 Retrieve deposit history

4. Fiat → Crypto Exchange

4.1 Retrieve available markets

4.2 Retrieve market settings (fees, min-order)

4.3 Get exchange estimate

4.4 Execute fiat→crypto exchange

5. Crypto Withdrawal

5.1 Create or select a withdrawal requisite

5.2 Retrieve crypto asset settings

5.3 Initiate the withdrawal

5.4 Retrieve withdrawal history

6. End-to-End Flow Summary

Fiat Deposit (From Card Only) → Instant Fiat-to-Crypto Conversion → Crypto Withdrawal

Prerequisites

1. Valid Auth-Token

2. Member Registration

3. Successful Login

4. HMAC Signatures Required

5. Webhooks Are Preconfigured Internally

1. Provider Selection

1.1 Fetch available fiat providers

2. Customer Registration at Corefy

2.1 Register customer at provider