Obtaining lists of partner exchanges

Available API methods

Base URL:

https://your-domain.com

Each endpoint looks like this:

https://your-domain.com/api/v1/{endpoint}

• All endpoints return time in Unix-time format.

• Responses comply with the JSON:API.

List of available methods

• Retrieving the list of partner exchanges (referral exchanges):

Method: “Get list of partner exchanges”

Description:

Returns a list of referral exchanges associated with your partner account.

HTTP method used:

GET /api/v1/partner/referral-exchanges

Headers

Name	Value
X-API-Key	<your_api_key>

Response

200

{
  "data": [
    {
      "type": "referral_exchange",
      "id": 1611085,
      "attributes": {
        "is_completed": true,
        "completed_at": 1691234567,
        "created_at": 1691230000,
        "exchange_currency_in": "USDTTRC20",
        "exchange_currency_out": "BTC",
        "exchange_amount": "0.05000000",
        "referral_reward": "12.50000000",
        "referral_reward_base_currency": "USDT",
        "transition_query_params": {
          "utm_source": "telegram",
          "utm_medium": "referral",
          "utm_campaign": "crypto_exchange_promo",
          "utm_content": "banner_usdt_to_btc",
          "utm_term": "usdt_btc_swap",
          "pid": "1101231"
        }
      }
    }
  ],
  "links": {
    "next_page": "https://your-domain.com/api/v1/partner/referral-exchanges?page=2",
    "previous_page": null
  },
  "counts": {
    "total": 2,
    "last_page": 2
  }
}

401

422

Field explanations:

• is_completed: whether the exchange has completed (boolean)

• completed_at: completion time (Unix timestamp)

• created_at: creation time (Unix timestamp)

• exchange_currency_in: currency the customer gives

• exchange_currency_out: currency the customer receives

• exchange_amount: exchange amount

• referral_reward: referral reward

• referral_reward_base_currency: referral reward base currency

• transition_query_params: contains the query parameters passed when a user visits the website through your referral link. You can include your own custom parameters (for example, UTM tags) in the referral link - they will be stored in this field. This allows you to track the source, campaign, medium, and other marketing attributes of the referral traffic.

  • Example:

    • Base referral link:

      https://example.com?rid=123

    • With optional UTM tags:

      https://example.com?rid=123&utm_source=telegram&utm_medium=referral&utm_campaign=crypto_promo