### Create fixed-rate exchange Source: https://documenter.getpostman.com/view/8180765/SVfTPnM8/index Initiates a new fixed-rate exchange, providing a deposit address and details for the transaction. The deposit must be made within a specified timeframe. ```APIDOC ## POST /exchange/fixed ### Description Creates a new fixed-rate exchange. This endpoint returns a deposit address where the user must send their funds within a specified time limit (typically 20 minutes) for the exchange to proceed. ### Method POST ### Endpoint /exchange/fixed ### Request Body - **fromCurrency** (string) - Required - The currency the user is sending. - **toCurrency** (string) - Required - The currency the user wants to receive. - **amount** (number) - Required - The amount of the `fromCurrency` to be exchanged. - **address** (string) - Required - The user's wallet address to receive the exchanged funds. - **refundAddress** (string) - Optional - The user's refund address in case the exchange cannot be completed. - **extraId** (string) - Optional - Additional identifier for certain cryptocurrencies (e.g., Memo for XRP, Tag for XLM). - **refundExtraId** (string) - Optional - Additional identifier for the refund address. ### Request Example ```json { "fromCurrency": "btc", "toCurrency": "eth", "amount": 0.01, "address": "0x123abc...", "refundAddress": "0x456def..." } ``` ### Response #### Success Response (200) - **transactionId** (string) - The unique identifier for the created transaction. - **depositAddress** (string) - The address where the user must deposit their funds. - **depositAmount** (number) - The exact amount to be deposited. - **validUntil** (string) - The timestamp until which the deposit is valid (ISO 8601 format). - **orderId** (string) - An identifier for the order. #### Response Example ```json { "transactionId": "tx12345abc", "depositAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa", "depositAmount": 0.01, "validUntil": "2023-10-27T10:00:00Z", "orderId": "ord6789xyz" } ``` ``` -------------------------------- ### List of available currencies Source: https://documenter.getpostman.com/view/8180765/SVfTPnM8/index Retrieves a list of all currently available currencies for exchange. Supports filtering for fixed-rate options. ```APIDOC ## GET /currencies ### Description Retrieves a list of all currently available currencies for exchange. Use the `_fixedRate=true` query parameter to filter for currencies available for fixed-rate exchanges. ### Method GET ### Endpoint /currencies ### Query Parameters - **_fixedRate** (boolean) - Optional - Set to `true` to list only currencies available for fixed-rate exchanges. ### Response #### Success Response (200) - **currencies** (array) - A list of available currency objects. - **id** (string) - The unique identifier for the currency. - **name** (string) - The human-readable name of the currency. - **symbol** (string) - The ticker symbol for the currency. - **fixedRateEnabled** (boolean) - Indicates if the currency supports fixed-rate exchanges. #### Response Example ```json { "currencies": [ { "id": "btc", "name": "Bitcoin", "symbol": "BTC", "fixedRateEnabled": true }, { "id": "eth", "name": "Ethereum", "symbol": "ETH", "fixedRateEnabled": true } ] } ``` ``` -------------------------------- ### Exchange range fixed-rate Source: https://documenter.getpostman.com/view/8180765/SVfTPnM8/index Retrieves the minimum and maximum exchange amounts for a given currency pair for fixed-rate exchanges. ```APIDOC ## GET /exchange/range/fixed ### Description Retrieves the minimum and maximum exchange amounts for a specified currency pair when using the fixed-rate exchange flow. ### Method GET ### Endpoint /exchange/range/fixed ### Query Parameters - **fromCurrency** (string) - Required - The currency the user is sending. - **toCurrency** (string) - Required - The currency the user wants to receive. ### Response #### Success Response (200) - **currencyPair** (string) - The currency pair (e.g., BTC_ETH). - **amountFrom** (number) - The minimum amount that can be exchanged from the `fromCurrency`. - **amountTo** (number) - The maximum amount that can be exchanged from the `fromCurrency`. - **estimatedAmount** (number) - The estimated amount to be received in the `toCurrency` for a standard exchange amount. - **maxInOneTx** (number) - The maximum amount allowed in a single transaction. #### Response Example ```json { "currencyPair": "BTC_ETH", "amountFrom": 0.001, "amountTo": 10, "estimatedAmount": 0.15, "maxInOneTx": 10 } ``` ``` -------------------------------- ### Estimated fixed-rate exchange amount Source: https://documenter.getpostman.com/view/8180765/SVfTPnM8/index Calculates the estimated amount of the target currency based on the source currency, amount, and a given currency pair for fixed-rate exchanges. ```APIDOC ## GET /exchange/estimated/fixed ### Description Calculates the estimated amount of the target currency you will receive for a fixed-rate exchange, given the source currency, amount, and destination currency. ### Method GET ### Endpoint /exchange/estimated/fixed ### Query Parameters - **fromCurrency** (string) - Required - The currency the user is sending. - **toCurrency** (string) - Required - The currency the user wants to receive. - **amount** (number) - Required - The amount of the `fromCurrency` to be exchanged. - **fixRateSurcharge** (number) - Optional - A surcharge percentage to apply to the fixed rate. ### Response #### Success Response (200) - **estimatedAmount** (number) - The estimated amount of the `toCurrency` to be received. - **currencyPair** (string) - The currency pair (e.g., BTC_ETH). - **depositFee** (number) - The fee for depositing funds. - **serviceFee** (number) - The service fee for the exchange. #### Response Example ```json { "estimatedAmount": 0.15, "currencyPair": "BTC_ETH", "depositFee": 0.0001, "serviceFee": 0.005 } ``` ``` -------------------------------- ### Transaction status Source: https://documenter.getpostman.com/view/8180765/SVfTPnM8/index Retrieves the current status of a specific cryptocurrency exchange transaction using its ID. ```APIDOC ## GET /transaction/{transactionId}/status ### Description Retrieves the current status of a cryptocurrency exchange transaction. This endpoint is useful for monitoring the progress of an exchange after the deposit has been made. ### Method GET ### Endpoint /transaction/{transactionId}/status ### Path Parameters - **transactionId** (string) - Required - The unique identifier of the transaction to check. ### Response #### Success Response (200) - **transactionId** (string) - The unique identifier of the transaction. - **status** (string) - The current status of the transaction (e.g., "waiting", "confirmed", "exchanged", "completed", "failed"). - **address** (string) - The deposit address for the transaction. - **amountReceived** (number) - The amount of the source currency received. - **amountSent** (number) - The amount of the destination currency sent. - **currencyPair** (string) - The currency pair for the exchange. #### Response Example ```json { "transactionId": "tx12345abc", "status": "confirmed", "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa", "amountReceived": 0.01, "amountSent": 0.15, "currencyPair": "BTC_ETH" } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.