Wallet Trade Dcp Fixed-Income
More...
NAV Navbar
json

Changelogs

version time content
V1.0.0
2022-05-27
 initial version
V1.0.1
2024-11-15
 1. post fixed-income/api/v2/order add out_serial_number, to keep fields consistent between request and response.
2. get /fixed-income/api/v2/product change user_purchase_limit_dec to real limit
V1.0.2
2025-12-15
 1. add is_auto_renew ,renew_term to Make Order.
2. remove obsoleted renew_type from doc
V1.0.3
2026-01-26
 1. Add tokenize loan api.
2. Support renew type only principal / principal and interest (when placing an order and the order is held).
3.Support the switch option for interest withdrawal (when placing an order and the order is held).
4. Support users to query the interest withdrawal record information of orders (newly added interface)

Introduction

Communication Protocol

HTTPS Protocol.

Encoding

The request and response data code for all interfaces is formatted according to UTF-8. Content for responses in all interfaces is formatted according to JSON.

API Request Structure

Name Description Notes
API Address Address for API interface Eg. https://mapi.matrixport.com/fixed-income/api/v2/products
Public Parameters Universal parameters for all interfaces
Private Parameter Special parameters for each interface See each API interface description for details

API hosts (production)

Public Parameters

Public parameters are used for interface authentication. Unless otherwise necessary, these parameters will be omitted for each interface. Each request must contain these parameters unless stated otherwise.

Parameter Name Type Mandatory Limit Description
x-request-id string N - Globally unique trace id, used for tracing requests, Strongly recommended to pass in the request header.

Response Format Strings

All interface response values are formatted according to JSON. Unless otherwise stated, all request return values contain the following text strings:

Parameter Name Type Description
code int Interface call status, (ie. error code): 0: Normal, Others: Call error.
message string Error message is description of API errors
data object Results will return as defined by each interface

Authentication

please refer to this link

Fixed-Income API

Products List

Parameter Name Type Mandatory Limit Description
currency string N 64 Available currency: USDT, USDC, BTC, ETH, DAI, DOGE, DOT, LTC. Empty values indicate products for all currencies
offset integer N - Offset is 0 by default.
limit integer N - Page limit is 10 lines by default. 
curl "https://mapi.matrixport.com/fixed-income/api/v2/products?currency=USDT&timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"

{
  "code": 0,
  "message": "",
  "data": {
    "count": 23, //integer, query amount; Return amount is set according to the offset and limit
    "items": [
      //array,items
      {
        "id": "6820591484295766016", //string, Product id
        "currency": "USDT", //string, Investment currency
        "can_redeem": 1, //int, Can redeem early? 0: no, 1: yes
        "redeem_ror": 0, //integer, Annual interest for early redemption, e8
        "ror": 12000000, //integer, Annual interest, e8, 12% annual interest

        "interest_withdraw_show": false, // bool, Whether to show interest withdraw switch
        "interest_withdraw_frequency": 30, //integer, Interest Withdraw Frequency 30/90

        "status": 2, //integer, Product status: 1: Pending 2: Available 3: Sold out 4: Outdated(can not buy)
        "agreements": null, //array, Product protocol; See Product Interface details on structure definition;
        "tags": [
          //array, Product Label (Displays behind product name to entice users to purchase,. For example, "Redeem Early", "Star Product"）
          {
            "id": 5216, //integer, Label ID
            "deleted_at": null, //integer,Deletion Time
            "product_id": "6820591484295766016", //string, Product ID
            "language": "zh-CN", //string, Product Language
            "tag": "High interest", //string, Label Content
          },
        ],
        "i18n": [
          //array, Multilingual Product Info
          {
            "id": 19004, //integer, Multilingual ID
            "product_id": "6820591484295766016", //string, Product ID
            "language": "zh-CN", //string, Language
            "name": "USDT Fixed Interest M0121", //string, Product name
            "introduction": "Fixed Interest Product", //string, Product Info
            "basic_rule":
              "Minimum purchase amount is set to 100 USDT；Cannot redeem early ", //string, Basic Rules
          },
        ],
        "duration": {
          "close_day": 3, //integer, Close Days, Unit: Days
          "value_day": 0, //integer, Value Date: T+x, Unit: Days
          "value_time": 64800, //integer, Value Time: 12:00 is 12*3600
          "value_limit": 0, //integer, Interest Limit;0: No limit,1: Excludes weekends
          "end_settled_day": 0, //integer, Closing Date for Settlement, T+x
          "end_settled_time": 68400, //integer, Closing Time for Settlement: 12:00 is 12*3600
        },
        "fund_investments": null, //array, Funds destination; Product list does not return this data string. View the Product Info Interface for structural information.
        "raised_time": 1626170400, //integer, Raise End Time
        "start_closed_time": 1626170400, //integer, Close Start Time
        "end_closed_time": 1626429600, //integer, Close End Time
        "end_settled_time": 1626433200, //integer, Closing Time for Settlement
      },
    ],
  }
}
Parameter Name Type Description
count integer query amount; Return amount is set according to the offset and limit
items array items
items.id string Product id
items.currency string Investment currency
items.minimum_of_purchase_amount_dec decimal/string Minimum single transaction amount
items.maximum_of_purchase_amount_dec decimal/string Maximum single transaction amount
items.user_purchase_limit_dec decimal/string Maximum single user purchase amount
items.can_redeem int Can redeem early? 0: no, 1: yes
items.redeem_ror integer Annual interest for early redemption, e8
items.ror integer Annual interest, e8, 12% annual interest
items.interest_withdraw_show bool Whether to show interest withdraw switch
items.interest_withdraw_frequency integer Interest Withdraw Frequency 30/90
items.status integer Product status: 1: Pending 2: Available 3: Sold out 4: Outdated(can not buy)
items.agreements array Product protocol; See Product Interface details on structure definition;
items.tags array Product Label (Displays behind product name to entice users to purchase,. For example, "Redeem Early", "Star Product"）
items.tags.id integer Label ID
items.tags.deleted_at integer Deletion Time
items.tags.product_id string Product ID
items.tags.language string Product Language
items.tags.tag string Label Content
items.i18n array Multilingual Product Info
items.i18n.id integer Multilingual ID
items.i18n.product_id string Product ID
items.i18n.language string Language
items.i18n.name string Product name
items.i18n.introduction string Product Info
items.i18n.basic_rule string Basic Rules
items.duration.close_day integer Close Days, Unit: Days
items.duration.value_day integer Value Date: T+x, Unit: Days
items.duration.value_time integer Value Time: 12:00 is 12*3600
items.duration.value_limit integer Interest Limit;0: No limit,1: Excludes weekends
items.duration.end_settled_day integer Closing Date for Settlement, T+x
items.duration.end_settled_time integer Closing Time for Settlement: 12:00 is 12*3600
items.fund_investments array Funds destination; Product list does not return this data string. View the Product Info Interface for structural information.
items.raised_time integer Raise End Time
items.start_closed_time integer Close Start Time
items.end_closed_time integer Close End Time
items.end_settled_time integer Closing Time for Settlement

Product Detail

Parameter Name Type Mandatory Limit Description
product_id string Y 64 Product ID: 6820591484295766016 
curl "https://mapi.matrixport.com/fixed-income/api/v2/product?product_id=xxxx&timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"

{
  "code": 0,
  "message": "",
  "data": {
    "id": "6820591484295766016", //string, Product id
    "currency": "USDT", //string, Investment Currency
    "minimum_of_purchase_amount_dec": "100", //decimal, Minimum single transaction amount; initial investment amount,
    "maximum_of_purchase_amount_dec": "1000", //decimal, Maximum single transaction amount,
    "user_purchase_limit_dec": "1000", //decimal, Maximum single user purchase amount,
    "can_redeem": 1, //int, Can redeem early? 0: no, 1: yes
    "redeem_ror": 0, //integer, Redeem annual interest early, e8
    "ror": 12000000, //integer, Annual interest, e8 12% annual interest

    "interest_withdraw_show": false, // bool, Whether to show interest withdraw switch
    "interest_withdraw_frequency": 30, //integer, Interest Withdraw Frequency 30/90

    "status": 2, //integer, Product status: 1: Pending 2: Available 3: Sold out 4: Outdated(can not buy)
    "agreements": [
        {
            "id": 11766, //integer, agreement id
            "product_id": "6820591484295766016", //string, Product id
            "agreement": "abs123456" //string, agreement name
        }
    ],
    "tags": [
        {
            "id": 5216, //integer, Label ID
            "deleted_at": null,  //string, Product ID
            "product_id": "6820591484295766016", //string, Product id
            "language": "zh-CN", //string, Product Language
            "tag": "High revenue" //string, Label Content
        },
    ],
    "i18n": [ //array, Multilingual Product Info
        {
            "id": 19006, //integer, Multilingual ID
            "product_id": "6820591484295766016",  //string, Product ID
            "language": "en", //string, Language
            "name": "USDT Fixed-Term M012111", //string, Product Name
            "introduction": "10086", //string, Product Info
            "basic_rule": "10086"   //string, Basic Rules
        },

    ],
    "duration": {
        "close_day": 3, //integer, Close Days, Unit: Days
        "value_day": 0, //integer, Close Days, Unit: Days
        "value_time": 64800, //integer, Value Time: 12:00 is 12*3600
        "value_limit": 0, //integer, Interest Limit;0: No limit, 1: Excludes weekends
        "end_settled_day": 0, //integer, Closing Date for Settlement, T+x
        "end_settled_time": 68400, //integer, Closing Time for Settlement: 12:00 is 12*3600
    },
    "fund_investments": [
        {
            "id": 764, //integer, Investment Destination ID
            "product_id": "6820591484295766016", //string, Product ID
            "language": "en", //string, Language
            "fund_investment": "Investment Destination Info (EN)" //string, Investment Destination Info
        },

    ],
    "raised_time": 1626170400, //integer, Raise End Time
    "start_closed_time": 1626170400, //integer, Close Start Time
    "end_closed_time": 1626429600, //integer, Close End Time
    "end_settled_time": 1626433200 //integer, Closing Time for Settlement
  }
}
Parameter Name Type Description
id string Product id
currency string Investment Currency
minimum_of_purchase_amount_dec decimal/string Minimum single transaction amount;
maximum_of_purchase_amount_dec decimal/string Maximum single transaction amount;
user_purchase_limit_dec decimal/string Maximum single user purchase amount;
amount which user can buy: minimum_of_purchase_amount_dec <= amount <= min(maximum_of_purchase_amount_dec, user_purchase_limit_dec)
can_redeem int Can redeem early? 0: no, 1: yes
redeem_ror integer Redeem annual interest early, e8
ror integer Annual interest, e8 12% annual interest
interest_withdraw_show bool Whether to show interest withdraw switch
interest_withdraw_frequency integer Interest Withdraw Frequency 30/90
status integer Product status: 1: Pending 2: Available 3: Sold out 4: Outdated(can not buy)
agreements.id integer agreement id
agreements.product_id string Product id
agreements.agreement string agreement name
tags.id integer Label ID
tags.deleted_at string Product ID
tags.product_id string Product id
tags.language string Product Language
tags.tag string Label Content
i18n array Multilingual Product Info
i18n.id integer Multilingual ID
i18n.product_id string Product ID
i18n.language string Language
i18n.name string Product Name
i18n.introduction string Product Info
i18n.basic_rule string Basic Rules
duration.close_day integer Close Days, Unit: Days
duration.value_day integer Close Days, Unit: Days
duration.value_time integer Value Time: 12:00 is 12*3600
duration.value_limit integer Interest Limit;0: No limit, 1: Excludes weekends
duration.end_settled_day integer Closing Date for Settlement, T+x
duration.end_settled_time integer Closing Time for Settlement: 12:00 is 12*3600
fund_investments.id integer Investment Destination ID
fund_investments.product_id string Product ID
fund_investments.language string Language
fund_investments.fund_investment string Investment Destination Info
raised_time integer Raise End Time
start_closed_time integer Close Start Time
end_closed_time integer Close End Time
end_settled_time integer Closing Time for Settlement

Remaining Quota

Parameter Name Type Mandatory Limit Description
product_id string Y 64 Product ID: 6820591484295766016 
curl "https://mapi.matrixport.com/fixed-income/api/v2/product/quota?product_id=xxxx&timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"

{
  "code": 0,
  "message": "",
  "data": {
    "product_left_quota_dec": "1000", //decimal, Products remaining；-1 indicates no limit
    "user_left_quota_dec": "1000", //decimal, Products available to user；-1 indicates no limit
    "minimum_of_purchase_amount_dec": "100", //decimal, Minimum purchase amount
    "maximum_of_purchase_amount_dec": "1000" //decimal, Maximum purchase amount
  }
}
Parameter Name Type Description
product_left_quota_dec decimal/string Products remaining；-1 indicates no limit
user_left_quota_dec decimal/string Products available to user；-1 indicates no limit
minimum_of_purchase_amount_dec decimal/string Minimum purchase amount
maximum_of_purchase_amount_dec decimal/string Maximum purchase amount

Investment Trials

Parameter Name Type Mandatory Limit Description
product_id string Y 64 Product ID: 6820591484295766016
coupon_ror integer N - Coupon Profit Rate e8
investment_dec decimal/string Y - Investment Amount, eg 100 
curl "https://mapi.matrixport.com/fixed-income/api/v2/product/invest/trial?product_id=xxxx&investment=10000000&timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"


{
  "code": 0,
  "message": "",
  "data": {
    "estimate_settle_amount_dec": "301", //decimal, Estimated settlement amount；
    "estimate_profit_dec": "33184931", //decimal, Estimated Profit
    "coupon_profit_dec": "0", //decimal, Coupon Profit
    "currency": "USDT" //string, Currency
  }
}
Parameter Name Type Description
estimate_settle_amount_dec decimal/string Estimated settlement amount；
estimate_profit_dec decimal/string Estimated Profit
coupon_profit_dec decimal/string Coupon Profit
currency string Currency

Make Order

Parameter Name Type Mandatory Limit Description
product_id string Y 64 Product ID: 6820591484295766016
amount_dec decimal/string Y - Investment Amount
coupon_id integer N - Coupon ID
is_auto_renew integer N - 0: Auto-renewal disabled; 1: Auto-renewal enabled
interest_withdraw_enabled boolean N - whether to withdraw interest if product support interest withdrawal
renew_principal_type integer N - 1: only renew principal; 0: renew principal and interest
renew_term integer N - product term expected for next renewal order
serial_number string N - same as out_serial_number; Max length 32, unique serial_number provided by client, not mandatory (NOT RECOMMENDED)
out_serial_number string N - Max length 32, unique serial_number provided by client, strongly recommend 
curl -H "Content-Type:application/json" -X POST --data '{"product_id":xxxx,"amount":1000000,"timestamp":1628909085000,"signature":9117bd1e5587e8318456e52e091136f1eb84ffebc1f2b9656573344962acc81a}'
 https://mapi.matrixport.com/fixed-income/api/v2/order


{
  "code": 0,
  "message": "",
  "data": {
    "serial_number": "6820608333133701120", //string, Serial Number, used as order ID.
    "out_serial_number": "6820608333133701120", //string, Out Serial Number.
  }
}
Parameter Name Type Description
serial_number string Serial number return in make order api, used as order ID
out_serial_number string Out Serial number

Order Result

Parameter Name Type Mandatory Limit Description
serial_number string N 32 Serial Number: 6820608333133701120
out_serial_number string N 32 Serial number provided by client, if exist. 
curl "https://mapi.matrixport.com/fixed-income/api/v2/order/result?serial_number=xxxx&timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"


{
  "code": 0,
  "message": "",
  "data": {
    "status": 0, //integer, Results 0 Purchasing 1 Purchased 2 Purchase failed, see failed_code and failed_message
    "failed_code": 0, //integer, Failure Code
    "failed_message": "" //string, Failure Message
    "order_id": "6820608333133701120", //string, Order ID
  }
}
Parameter Name Type Description
status integer Results 0 Purchasing 1 Purchased 2 Purchase failed, see failed_code and failed_message
failed_code integer Failure Code
failed_message string Failure Message
order_id string OrderId

Order List

Parameter Name Type Mandatory Limit Description
currency string N - Investment Currency
order_status array N - Order Status: 1(Pre-order), 3(Canceled, Final),4(Holding),5(Pending),6(Setting),7(Setted, Final),15(Redeemed All, Final),16(Redeeming)
offset integer N - offset
limit integer N - Limit per page
time_gt integer N - Query orders with end_closed_time greater than this timestamp (seconds)
time_lt integer N - Query orders with end_closed_time less than this timestamp (seconds)
book_time_gt integer N - Query orders with book_time greater than this timestamp (seconds)
book_time_lt integer N - Query orders with book_time less than this timestamp (seconds) 
curl "https://mapi.matrixport.com/fixed-income/api/v2/orders?order_status=4&timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"


{
  "code": 0,
  "message": "",
  "data": {
    "count": 1, //integer, Count of Orders
    "items": [
        {
            "id": "6820608333133701120", //string, Order ID
            "out_serial_number": "out_serial_number", //string, out_serial_number if exists
            "product_id": "6820591484295766016", //string, Product ID
            "can_redeem": 1, //int, Can redeem early? 0: no, 1: yes
            "currency": "USDT", //string, Investment Currency
            "book_time": 1626159747, //integer, Order Time
            "amount_dec": "10000000000", //decimal, Investment Amount,

            "interest_withdraw_enabled": true, //bool, Whether to withdraw interest if product support interest withdrawal
            "interest_withdraw_show": true, //bool, Whether to show interest withdraw switch
            "interest_withdraw_frequency": 30, //integer, Interest Withdraw Frequency 30/90
            "renew_principal_type": 1, //integer, 1: only renew principal; 0: renew principal and interest

            "start_closed_time": 1626170400, //integer, Close Start Time
            "end_closed_time": 1626429600, //integer, Close End Time
            "end_settled_time": 1626433200, //integer, Closing Time for Settlement
            "duration": {
                "close_day": 3, //integer, Close Days, Unit: Days
                "value_day": 0, //integer, Close Days, Unit: Days
                "value_time": 64800, //integer, Value Time: 12:00 is 12*3600
                "value_limit": 0, //integer, Interest Limit;0: No limit, 1: Excludes weekends
                "end_settled_day": 0, //integer, Closing Date for Settlement,T+x
                "end_settled_time": 68400, //integer, Closing Time for Settlement: 12:00 is 12*3600
            },
            "ror": 12000000, //integer, Real rate of return, e8
            "redeem_ror": 0, //integer, Redeem annual interest early
            "payback_dec": "0", //decimal, Actual collection, information flow or capital flow,
            "redeem_principal_dec": "0", //decimal, Order capital returned,
            "is_auto_renew": 0, //integer, Activate auto renewal? 0: No 1: Yes; Priority is less than manual renewal.
            "order_status": 1, //integer, Order Status: 1(Pre-order), 3(Canceled, Final),4(Holding),5(Pending),6(Setting),7(Setted, Final),15(Redeemed All, Final),16(Redeeming)
            "i18n": [ //array, Multilingual Product Info
                {
                    "id": 19006, //integer, Multilingual ID
                    "product_id": "6820591484295766016", //string, Product ID
                    "language": "en", //string, Language
                    "name": "USDT Fixed-Term M012111", //string, Product Name
                    "introduction": "10086",  //string, Product Info
                    "basic_rule": "10086"  //string, Basic Rules
                },
            ],
            "redeeming_amount_dec": "0", //decimal, Redeeming Amount (amount pending approval and processing)
            "estimate_settle_amount_dec": "301", //decimal, Est. Settlement Amount (trial value based on investment information, for reference only
            "can_renew_product_count": 4 //integer, Renewable Product Count
        }
    ]
  }
}
Parameter Name Type Description
count integer Count of Orders
items.id string Order ID
items.out_serial_number string out_serial_number if exists
items.product_id integer Product ID
items.can_redeem int Can redeem early? 0: no, 1: yes
items.currency string Investment Currency
items.book_time integer Order Time
items.amount_dec decimal/string Investment Amount
items.start_closed_time integer Close Start Time
items.end_closed_time integer Close End Time
items.end_settled_time integer Closing Time for Settlement
items.interest_withdraw_enabled boolean Whether to withdraw interest if product support interest withdrawal
items.interest_withdraw_show boolean Whether to show interest withdraw switch
items.interest_withdraw_frequency integer Interest Withdraw Frequency 30/90
items.renew_principal_type integer 1: only renew principal; 0: renew principal and interest
items.duration.close_day integer Close Days, Unit: Days
items.duration.value_day integer Close Days, Unit: Days
items.duration.value_time integer Value Time: 12:00 is 12*3600
items.duration.value_limit integer Interest Limit;0: No limit, 1: Excludes weekends
items.duration.end_settled_day integer Closing Date for Settlement,T+x
items.duration.end_settled_time integer Closing Time for Settlement: 12:00 is 12*3600
items.ror integer Real rate of return, e8
items.redeem_ror integer Redeem annual interest early
items.payback_dec decimal/string Actual settled, information flow or capital flow
items.redeem_principal_dec decimal/string Order capital returned
items.is_auto_renew integer Activate auto renewal? 0: No 1: Yes; Priority is less than manual renewal.
items.order_status integer Order Status: 1(Pre-order), 3(Canceled, Final),4(Holding),5(Pending),6(Setting),7(Setted, Final),15(Redeemed All, Final),16(Redeeming)
items.i18n array Multilingual Product Info
items.i18n.id integer Multilingual ID
items.i18n.product_id string Product ID
items.i18n.language string Language
items.i18n.name string Product Name
items.i18n.introduction string Product Info
items.i18n.basic_rule string Basic Rules
items.redeeming_amount_dec decimal/string Redeeming Amount (amount pending approval and processing)
items.estimate_settle_amount_dec decimal/string Est. Settlement Amount (trial value based on investment information, for reference only
items.can_renew_product_count integer Renewable Product Count

Order Details

Parameter Name Type Mandatory Limit Description
order_id string Y 64 Order ID: 6820608333133701120 
curl "https://mapi.matrixport.com/fixed-income/api/v2/order?order_id=xxxx&timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"


{
  "code": 0,
  "message": "",
  "data": {
    "id": "6820608333133701120", //string, Order ID
    "product_id": 6820591484295766016, //integer, Product ID
    "can_redeem": 1, //int, Can redeem early? 0: no, 1: yes
    "currency": "USDT", //string, Investment Currency
    "book_time": 1626159747, //integer, Order Time
    "amount_dec": 10000000000, //decimal, Investment Amount,
    "start_closed_time": 1626170400, //integer, Close Start Time
    "end_closed_time": 1626429600, //integer, Close End Time
    "end_settled_time": 1626433200, //integer, Closing Time for Settlement
    "duration": {
        "close_day": 3, //integer, Close Days, Unit: Days
        "value_day": 0, //integer, Close Days, Unit: Days
        "value_time": 64800, //integer, Value Time: 12:00 is 12*3600
        "value_limit": 0, //integer, Interest Limit;0: No limit, 1: Excludes weekends
        "end_settled_day": 0, //integer, Closing Date for Settlement, T+x
        "end_settled_time": 68400, //integer, Closing Time for Settlement: 12:00 is 12*3600
    },
    "ror": 12000000, //integer, Real rate of return, e8
    "redeem_ror": 0, //integer, Redeem annual interest early
    "payback_dec": 0, //decimal, Actual settled, information flow or capital flow
    "redeem_principal_dec": 0, //decimal, Order capital returned
    "is_auto_renew": 0, //integer, Activate auto renewal? 0: No 1: Yes; Priority is less than manual renewal.
    "order_status": 1, //integer, Order Status: 1(Pre-order), 3(Canceled, Final),4(Holding),5(Pending),6(Setting),7(Setted, Final),15(Redeemed All, Final),16(Redeeming)
    "i18n": [ //array, Multilingual Product Info
        {
            "id": 19006, //integer, Multilingual ID
            "product_id": "6820591484295766016", //string, Product ID
            "language": "en", //string, Language
            "name": "USDT Fixed-Term M012111", //string, Product Name
            "introduction": "10086", //string, Product Info
            "basic_rule": "10086" //string, Basic Rules
        },
    ],
    "redeeming_amount_dec": 0, //decimal, Redeeming Amount (amount pending approval and processing)
    "estimate_settle_amount_dec": "301", //decimal, Est. Settlement Amount (trial value based on investment information, for reference onl
    "can_renew_product_count": 4 //integer, Renewable Product Count
  }
}
Parameter Name Type Description
id string Order ID
product_id integer Product ID
can_redeem int Can redeem early? 0: no, 1: yes
currency string Investment Currency
book_time integer Order Time
amount_dec decimal/string Investment Amount
start_closed_time integer Close Start Time
end_closed_time integer Close End Time
end_settled_time integer Closing Time for Settlement
duration.close_day integer Close Days, Unit: Days
duration.value_day integer Close Days, Unit: Days
duration.value_time integer Value Time: 12:00 is 12*3600
duration.value_limit integer Interest Limit;0: No limit, 1: Excludes weekends
duration.end_settled_day integer Closing Date for Settlement, T+x
duration.end_settled_time integer Closing Time for Settlement: 12:00 is 12*3600
ror integer Real rate of return, e8
redeem_ror integer Redeem annual interest early
payback_dec decimal/string Actual settled, information flow or capital flow,
redeem_principal_dec decimal/string Order capital returned,
is_auto_renew integer Activate auto renewal? 0: No 1: Yes; Priority is less than manual renewal.
order_status integer Order Status: 1(Pre-order), 3(Canceled, Final),4(Holding),5(Pending),6(Setting),7(Setted, Final),15(Redeemed All, Final),16(Redeeming)
i18n array Multilingual Product Info
i18n.id integer Multilingual ID
i18n.product_id string Product ID
i18n.language string Language
i18n.name string Product Name
i18n.introduction string Product Info
i18n.basic_rule string Basic Rules
redeeming_amount_dec decimal/string Redeeming Amount (amount pending approval and processing)
estimate_settle_amount_dec decimal/string Est. Settlement Amount (trial value based on investment information, for reference onl
can_renew_product_count integer Renewable Product Count

Get Order Original ID

Parameter Name Type Mandatory Limit Description
order_id string Y 64 Order ID: 7428347542544527360
USER-ID string Y - User ID (in request header) 
curl -X 'GET' \
  'http://localhost:8080/fixed-income/api/v2/order/renew/original_id?order_id=7428347542544527360' \
  -H 'accept: application/json' \
  -H 'USER-ID: 3297087'

{
  "code": 0,
  "data": {
    "original_id": "7427658343373811712"
  },
  "message": ""
}
Parameter Name Type Description
code integer Response code (0 for success)
data object Response data container
original_id string The original order ID from which this order renewed
message string Response message

User Asset Interest

Parameter Name Type Mandatory Limit Description
start_time integer Y - Unix timestamp for start time
end_time integer Y - Unix timestamp for end time
currency string N - Currency
order_id string N - Order ID

Note

Every time can query data no more than week, end_time-start_time <= 86400*7 Max count limit in single query is 100,000

curl "https://mapi.matrixport.com/fixed-income/api/v3/user-asset/interest?currency=USD&end_time=1627021721&start_time=1627021721&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"


{
  "code": 0,
  "data": [
    {
      "order_id": 7241762973243793000,
      "timestamp": 1727074800,
      "interest_type": 1, // 1 normal interest, 2 hedged interest, 3 settled interest
      "user_id": "3063182",
      "currency": "USDT",
      "ror": "0.05",
      "principal": "90.660461963930879424",
      "interest": "0.000517468390205084"
    }
  ]
}

Response Fields

Field Type Description
code integer Response code (0 indicates success)
data array Array of interest record objects
data[].order_id long Order ID
data[].timestamp integer Unix timestamp (seconds)
data[].interest_type integer Interest type:
1 - Normal interest
2 - Hedged interest
3 - Settled interest
data[].user_id string User ID
data[].currency string Currency code (e.g., USDT)
data[].ror string Rate of return
data[].principal string Principal amount
data[].interest string Interest amount

User Asset Statistics USD

Parameter Name Type Mandatory Limit Description
USER-ID string Y - User ID 
curl -X 'GET' \
  'https://mapi.matrixport.com/fixed-income/api/v3/user-asset/statistics_usd' \
  -H 'accept: application/json' \
  -H 'USER-ID: 605788'

{
  "code": 0,
  "data": {
    "total_asset": "0",
    "yesterday_interest": "2.739726027397260264",
    "holding_interest": "0",
    "accumulated_interest": "7.305936073059360704"
  },
  "message": ""
}
Parameter Name Type Description
total_asset decimal/string Total asset value in USD
yesterday_interest decimal/string Interest earned yesterday in USD
holding_interest decimal/string Current holding interest amount in USD
accumulated_interest decimal/string Total accumulated interest over all time in USD

Turn On Interest Withdrawal for an Order

Parameter Name Type Mandatory Limit Description
order_id string Y 64 Order ID: 7420307839417266176 
curl -X 'POST' \
  'https://mapi.matrixport.com/fixed-income/api/v3/order/interest_withdraw_enabled/switch/on' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "order_id": "7420307839417266176"
}'

{
  "code": 0,
  "data": {
    "id": "0",
    "created_on": 0,
    "modified_on": 0,
    "serial_number": "plan-FIIW74203078394-2648282327916516029",
    "interest_withdraw_scenario": "plan",
    "interest_withdraw_method": "system",
    "order_id": 7420307839417266000,
    "order": null,
    "redeem_order_id": 0,
    "order_redeem_record": null,
    "nominal_start_timestamp": 1769137200,
    "start_timestamp": 1769137200,
    "timestamp": 1769932800,
    "display_timestamp": 1769936400,
    "user_id": "605788",
    "currency": "BTC",
    "interest": "0.000100913242009132432",
    "status": 0,
    "display_text": "nextWithdraw",
    "can_now_withdraw": false,
    "display_index": 2,
    "display_interest": "0.000100913242009132432",
    "submit_email": "",
    "approve_email": "",
    "remark": "",
    "is_end": false,
    "is_fake": false,
    "hedge_interest_records_for_apply": null,
    "interest_withdraw_enabled": true,
    "interest_withdraw_show": true
  },
  "message": ""
}
Parameter Name Type Description
id string Record ID
created_on integer Creation timestamp
modified_on integer Modification timestamp
serial_number string Serial number for the interest withdrawal record
interest_withdraw_scenario string Scenario for interest withdrawal (e.g., "plan")
interest_withdraw_method string Method of interest withdrawal (e.g., "system")
order_id integer Associated order ID
order object/null Order details (null if not available)
redeem_order_id integer Associated redeem order ID
order_redeem_record object/null Order redeem record details (null if not available)
nominal_start_timestamp integer Nominal start timestamp
start_timestamp integer Start timestamp
timestamp integer Timestamp
display_timestamp integer Display timestamp
user_id string User ID
currency string Currency (e.g., "BTC")
interest string Interest amount as a string
status integer Status of the interest withdrawal record
display_text string Text for display (e.g., "nextWithdraw")
can_now_withdraw boolean Whether interest can be withdrawn now
display_index integer Display index
display_interest string Interest amount for display as a string
submit_email string Email for submission
approve_email string Email for approval
remark string Remarks or notes
is_end boolean Whether it's the end of the interest withdrawal cycle
is_fake boolean Whether this is a fake record
hedge_interest_records_for_apply object/array Hedge interest records for application (may be null)
interest_withdraw_enabled boolean Whether interest withdrawal is enabled for the order
interest_withdraw_show boolean Whether to show interest withdrawal switch

Turn Off Interest Withdrawal for an Order

Parameter Name Type Mandatory Limit Description
order_id string Y 64 Order ID: 7420307839417266176 
curl -X 'POST' \
  'https://mapi.matrixport.com/fixed-income/api/v3/order/interest_withdraw_enabled/switch/off' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "order_id": "7420307839417266176"
}'

{
  "code": 0,
  "data": null,
  "message": ""
}
Parameter Name Type Description
code integer Response code (0 for success)
data object/null Response data (null for this operation)
message string Response message

Get Interest Withdraw Plan

Parameter Name Type Mandatory Limit Description
order_id string Y 64 Order ID: 7420307839417266176 
curl -X 'GET' \
  'https://mapi.matrixport.com/fixed-income/api/v3/order/interest_withdraw_plan?order_id=7420307839417266176' \
  -H 'accept: application/json' \

{
  "code": 0,
  "data": {
    "records": [
      {
        "id": "0",
        "created_on": 0,
        "modified_on": 0,
        "serial_number": "plan-F-FIIW742030783--7302182359488325838",
        "interest_withdraw_scenario": "plan",
        "interest_withdraw_method": "system",
        "order_id": 7420307839417266000,
        "order": null,
        "redeem_order_id": 0,
        "order_redeem_record": null,
        "nominal_start_timestamp": 1769137200,
        "start_timestamp": 1769932800,
        "timestamp": 1769932800,
        "display_timestamp": 1769936400,
        "user_id": "605788",
        "currency": "BTC",
        "interest": "0",
        "status": 1,
        "display_text": "pausedWithdraw",
        "can_now_withdraw": true,
        "display_index": 2,
        "display_interest": "0",
        "submit_email": "",
        "approve_email": "",
        "remark": "",
        "is_end": false,
        "is_fake": true,
        "hedge_interest_records_for_apply": null,
        "interest_withdraw_enabled": false,
        "interest_withdraw_show": true
      }
    ]
  }
}
Parameter Name Type Description
code integer Response code (0 for success)
data object Response data container
data.records array Array of interest withdrawal plan records
data.records[].serial_number string Serial number for the interest withdrawal record
data.records[].interest_withdraw_scenario string Scenario for interest withdrawal (e.g., "plan")
data.records[].interest_withdraw_method string Method of interest withdrawal (e.g., "system")
data.records[].order_id integer Associated order ID
data.records[].redeem_order_id integer Associated redeem order ID
data.records[].nominal_start_timestamp integer Nominal start timestamp
data.records[].start_timestamp integer Start timestamp
data.records[].timestamp integer Timestamp
data.records[].display_timestamp integer Display timestamp
data.records[].user_id string User ID
data.records[].currency string Currency (e.g., "BTC")
data.records[].interest string Interest amount as a string
data.records[].status integer Status of the interest withdrawal record (Init 0, Success 1, Failed 2)
data.records[].display_text string Text for display (e.g., hadWithdraw, nextWithdraw, expectedWithdraw, pausedWithdraw, withdrawing, partialRedeemed, allRedeemed, adminWithdraw)
data.records[].display_index integer Display index
data.records[].display_interest string Interest amount for display as a string
data.records[].remark string Remarks or notes
data.records[].is_end boolean Whether it's the end of the withdraw record of order
data.records[].is_fake boolean Whether this is a fake record
data.records[].interest_withdraw_enabled boolean Whether interest withdrawal is enabled for the order
data.records[].interest_withdraw_show boolean Whether to show interest withdrawal switch

Turn Off Auto-renewal of an Order

Parameter Name Type Mandatory Limit Description
order_id string Y 64 Order ID: 6820626049743773696 
curl -H "Content-Type:application/json" -X POST --data '{"order_id":yyyyyy,"timestamp":1628909085000,"signature":9117bd1e5587e8318456e52e091136f1eb84ffebc1f2b9656573344962acc81a}'
 https://mapi.matrixport.com/fixed/api/v2/order/auto_renew/switch/off

{
  "code": 0,
  "message": "",
  "data": null
  }

Turn On Auto-renewal of an Order

Parameter Name Type Mandatory Limit Description
order_id string Y 64 Order ID: 6820626049743773696 
curl -H "Content-Type:application/json" -X POST --data '{"order_id":yyyyyy,"timestamp":1628909085000,"signature":9117bd1e5587e8318456e52e091136f1eb84ffebc1f2b9656573344962acc81a}'
 https://mapi.matrixport.com/fixed/api/v2/order/auto_renew/switch/on

{
  "code": 0,
  "message": "",
  "data": null
  }

Change Renew Term in Auto-renewal of an Order

Parameter Name Type Mandatory Limit Description
order_id string Y 64 Order ID: 6820626049743773696
renew_term int64 Y 64 renew term: 7 
curl -H "Content-Type:application/json" -X POST --data '{"order_id":yyyyyy,"timestamp":1628909085000,"renew_term":7,"signature":9117bd1e5587e8318456e52e091136f1eb84ffebc1f2b9656573344962acc81a}'
 https://mapi.matrixport.com/fixed-income/api/v3/order/auto_renew/change

{
  "code": 0,
  "message": "",
  "data": null
  }

Change Renew Principal Type of an Order

Parameter Name Type Mandatory Limit Description
order_id string Y 64 Order ID: 7420307839417266176
renew_principal_type integer Y - Renew principal type: 1 for principal only, 0 for principal and interest 
curl -X 'POST' \
  'https://mapi.matrixport.com/fixed-income/api/v3/order/renew_principal_type/change' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "order_id": "7420307839417266176",
  "renew_principal_type": 1
}'

{
  "code": 0,
  "data": null,
  "message": ""
}
Parameter Name Type Description
code integer Response code (0 for success)
data object/null Response data (null for this operation)
message string Response message

Auto Renewal Products

Parameter Name Type Mandatory Limit Description
order_id string Y 64 Order ID: 6820608333133701120 
curl "https://mapi.matrixport.com/fixed/api/v2/order/auto_renew/products?order_id=xxxx&timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"


{
  "code": 0,
  "message": "",
  "data": {
    "count": 1, //integer, Count
    "items": [ //array
        {
            "id": "6812413916300247040", //string, Product ID
            "currency": "USDT", //string, Investment Currency

            "can_redeem": 1, //int, Can redeem early? 0: no, 1: yes
            "redeem_ror": 9000000, //integer, Redeem Interest
            "ror": 12000000, //integer, Annual interest, e8 12% annual interest
            "status": 2, //integer, Product status: 1: Pending 2: Available 3: Sold out 4: Outdated(can not buy)
            "agreements": null, //array, Product protocol; See Product Interface details on structure definition; List Interface does not return this data string
            "tags": [
                {
                    "id": 5000, //integer, Label ID
                    "deleted_at": null, //integer, Deletion Time
                    "product_id": "6816308388557815808", //string, Product ID
                    "language": "zh-CN", //string, Product Language
                    "tag": "High interest" //string, Label Content
                },
            ],
            "i18n": [
                {
                    "id": 2450, //integer, Multilingual ID
                    "product_id": "6812413916300247040", //string, Product ID
                    "language": "zh-CN", //string, Language
                    "name": " Actively renew fixed products USDT 2021-06-21 00:20:46", //string, Product Name
                    "introduction": "123", //string, Product Info
                    "basic_rule": "" //string, Basic Rules
                }
            ],
            "duration": {
                "close_day": 4, //integer, Close Days, Unit: Days
                "value_day": 0, //integer, Value Date: T+x, Unit: Days
                "value_time": 0, //integer, Value Time: 12:00 is 12*3600
                "value_limit": 0, //integer, Interest Limit;0: No limit, 1: Excludes weekends
                "end_settled_day": 1, //integer, Closing Date for Settlement, T+x
                "end_settled_time": 43200, //integer, Closing Time for Settlement: 12:00 is 12*3600
            },
            "raised_time": 1626451200, //integer, Raise End Time
            "start_closed_time": 1626451200, //integer, Close Start Time
            "end_closed_time": 1626796800, //integer, Close End Time
            "end_settled_time": 1626926400 //integer, Closing Time for Settlement
        }
    ]
  }
}

Get Redeemable Amount of an Order

Parameter Name Type Mandatory Limit Description
order_id string Y 64 Order ID: 6820626049743773696 
curl "https://mapi.matrixport.com/fixed-income/api/v2/order/redeem/amount?order_id=xxxx&timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"


{
  "code": 0,
  "message": "",
  "data": {
    "order_id": "7049660130677260288", //string, order id
    "max_amount_dec": "1" //decimal, max redeemable principal amount.
  }
}
Parameter Name Type Description
order_id string order id
max_amount_dec string max redeemable principal amount.

Trial Calculation of Redemption

Parameter Name Type Mandatory Limit Description
order_id string Y 64 Order ID: 6820626049743773696
principal_dec string Y 64 redeem principal in decimal : "100.0" 
curl "https://mapi.matrixport.com/fixed-income/api/v2/order/redeem/trail?order_id=xxxx&principal_dec=100.0&timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"


{
  "code": 0,
  "message": "",
  "data": {
    "order_id": "7049660130677260288", //string, order id
    "redeem_ror": 5000000, //int, redeem ror in E8
    "redeem_amount_dec": "1.017756849315068493", //string, estimate redeem amount will received
    "profit_dec": "0.017756849315068493", //string, estimate total profit
    "redeem_principal_dec": "0.017756849315068493", //string, redeem principal
  }
}

resp_convert.py

Parameter Name Type Description
order_id string order id
redeem_ror int redeem ror in E8
redeem_amount_dec string estimate redeem amount will received
profit_dec string estimate total profit
redeem_principal_dec string redeem principal

Redeem an Order

Parameter Name Type Mandatory Limit Description
order_id string Y 64 Order ID: 6820626049743773696
principal_dec string Y 64 redeem principal in decimal : "100.0"; Notice: if principal_dec > left principal, will force to redeem all left principal, no warning/error will be given 
curl -H "Content-Type:application/json" -X POST --data '{"order_id":"xxxx","principal_dec":"100.0","timestamp":1628909085000,"signature":9117bd1e5587e8318456e52e091136f1eb84ffebc1f2b9656573344962acc81a}'
 https://mapi.matrixport.com/fixed-income/api/v2/order/redeem


{
  "code": 0,
  "message": "",
  "data": {
    "order_id": "7049660130677260288", //string, order id
    "redeem_ror": 5000000, //int, redeem ror in E8
    "redeem_amount_dec": "1.017756849315068493", //string, estimate redeem amount will received
    "profit_dec": "0.017756849315068493", //string, estimate total profit
    "coupon_profit_dec": "0", //string, estimate coupon profit
    "redeem_principal_dec": "1", //string, redeem principal

    "id": 6996844215246463000, //int, redeem id
    "ror": 4000000, //int, redeem ror of order
    "redeem_time": 1691479205, //int, redeem time
    "confirm_time": 0, //int, redeem confirm time
    "redeem_currency": "BTC", //string, redeem currency
    "status": 1, //int, redeem status; 1: Create a redemption order succeeded, 2: Redemption succeeded, 3: Redemption canceled, 4: Under review
  }
}
Parameter Name Type Description
order_id string order id
redeem_ror int redeem ror in E8
redeem_amount_dec string estimate redeem amount will received
profit_dec string estimate total profit
coupon_profit_dec string estimate coupon profit
redeem_principal_dec string redeem principal
id int redeem id
ror int redeem ror of order
redeem_time int redeem time
confirm_time int redeem confirm time
redeem_currency string redeem currency
status int redeem status; 1: Create a redemption order succeeded, 2: Redemption succeeded, 3: Redemption canceled, 4: Under review

Get Redemption Detail

Parameter Name Type Mandatory Limit Description
order_id string Y 64 Order ID: 6820626049743773696 
curl "https://mapi.matrixport.com/fixed-income/api/v2/order/redeem/detail?order_id=xxxx&timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"


{
  "code": 0,
  "data": {
    "order_payback": {
      "currency": "USDT",
      "ror": 10000000,
      "payback_time": 1770098390,
      "renew_order_id": "0",
      "settle_payback_dec": "7510.27397260273972596",
      "renew_only_principal_interest_payback": "0"
    },
    "redeem_orders": [
      {
        "order_id": "7424330587302998016",
        "redeem_ror": 0,
        "true_ror": 0,
        "redeem_time": 1770098350,
        "confirm_time": 1770098350,
        "redeem_currency": "USDT",
        "status": 2,
        "redeem_principal_dec": "2500",
        "redeem_profit_dec": "0",
        "withdrawn_interest_dec": "0",
        "redeem_amount_dec": "2500",
        "payback_currency": "",
        "user_id": "605788",
        "is_all_redeem": false,
        "interest_withdraw_status": 2
      }
    ],
    "redeeming_amount_dec": "0"
  },
  "message": ""
}
Parameter Name Type Description
order_payback object Order payback information
order_payback.currency string Payback currency
order_payback.ror integer Rate of return, e8
order_payback.payback_time integer Payback time (Unix timestamp)
order_payback.renew_order_id string Renewed order ID (0 if not renewed)
order_payback.settle_payback_dec decimal/string Settlement payback amount
order_payback.renew_only_principal_interest_payback decimal/string Interest payback for principal-only renewal
redeem_orders array Array of successful redemption orders
redeem_orders[].order_id string Redemption order ID
redeem_orders[].redeem_ror integer Redemption rate of return, e8
redeem_orders[].true_ror integer Actual rate of return, e8
redeem_orders[].redeem_time integer Redemption time (Unix timestamp)
redeem_orders[].confirm_time integer Confirmation time (Unix timestamp)
redeem_orders[].redeem_currency string Redemption currency
redeem_orders[].status integer Redemption status; 1: Create a redemption order succeeded, 2: Redemption succeeded, 3: Redemption canceled, 4: Under review
redeem_orders[].redeem_principal_dec decimal/string Redeemed principal amount
redeem_orders[].redeem_profit_dec decimal/string Redeemed profit amount
redeem_orders[].withdrawn_interest_dec decimal/string Withdrawn interest amount
redeem_orders[].redeem_amount_dec decimal/string Total redeemed amount (principal + profit)
redeem_orders[].payback_currency string Payback currency
redeem_orders[].user_id string User ID
redeem_orders[].is_all_redeem boolean Whether this is a full redemption
redeem_orders[].interest_withdraw_status integer Interest withdrawal status
redeeming_amount_dec decimal/string Amount currently in redeeming process

Coupon List

Parameter Name Type Mandatory Limit Description
product_id string Y - Product ID: 6820617394550005760
order_id string Y - Order ID: 6820967743295119360
amount_dec decimal/string N - Investment Amount
order_type integer N - Order Type， 0: New Order，1: Renewal Order 
curl "https://mapi.matrixport.com/fixed-income/api/v2/order/coupons?order_id=xxxx&timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"

{
  "code": 0,
  "message": "",
  "data": {
    "coupons": [
        {
            "id": "6820967743295119360", //string, Coupon ID
            "available": true, //boolean, Is it available?
            "expiration_time": 1657781438489, //integer,Expiration Time Milliseconds
            "year_rate": 16000000, //integer, Coupon Rate e8
            "min_amount_dec": "100000000", //decimal, Min available
            "max_amount_dec": "1000000000000", //decimal, Max available
            "template_names": [ //array, Template Name
                {
                    "item": "TemplateName",
                    "language": "En-US", //string, Language
                    "data": "10086",  //string, Event Name
                    "trigger": ""//string,
                },

            ]
        }
    ]
}
}
Parameter Name Type Description
coupons.id string Coupon ID
coupons.available boolean Is it available?
coupons.expiration_time integer Expiration Time Milliseconds
coupons.year_rate integer Coupon Rate e8
coupons.min_amount_dec decimal/string Min available
coupons.max_amount_dec decimal/string Max available
coupons.template_names array Template Name
coupons.template_names.language string Language
coupons.template_names.data string Event Name

User Group

Parameter Name Type Mandatory Limit Description
user_id string Y 64 User ID: xxxx
group_id string Y 64 Group ID: xxxx 
curl -H "Content-Type:application/json" -X POST --data '{"user_id":"xxxx","group_id":"yyyyyy","timestamp":1628909085000,"signature":9117bd1e5587e8318456e52e091136f1eb84ffebc1f2b9656573344962acc81a}'
 https://mapi.matrixport.com/group/agency/v1/user/bind

{
  "code": 0,
  "message": "",
  "data": null
}

Loanable Currency

Parameter Name Type Mandatory Limit Description 
curl -X 'GET' \
  'https://mapi.matrixport.com/fixed-income/api/v3/tokenize/loanable_currency' \
  -H 'accept: application/json' \

{
  "code": 0,
  "data": [
    {
      "cell_no": "7351548916653035520",
      "currency": "USDT",
      "precision": 0,
      "max_loan_amount_display": "9,000",
      "max_cefi_loan_amount": "46361934.517645819277146898",
      "min_loan_amount": "0.01",
      "max_loan_amount": "9000",
      "max_collateral_amount": "10000",
      "min_collateral_amount": "10000",
      "max_collateral_amount_usd": "10000",
      "total_quota": "2000000000",
      "used_quota": "5000",
      "left_quota": "46361934.517645819277146898"
    }
  ],
  "message": ""
}
Parameter Name Type Description
code integer Response code (0 for success)
data array Array of loanable currency information
data[].cell_no string Cell number identifier
data[].currency string Currency code (e.g., "USDT")
data[].precision integer Decimal precision for the currency
data[].max_loan_amount_display string Maximum loan amount formatted for display
data[].max_cefi_loan_amount string Maximum CeFi loan amount available
data[].min_loan_amount string Minimum loan amount
data[].max_loan_amount string Maximum loan amount
data[].max_collateral_amount string Maximum collateral amount
data[].min_collateral_amount string Minimum collateral amount
data[].max_collateral_amount_usd string Maximum collateral amount in USD
data[].total_quota string Total quota available
data[].used_quota string Amount of quota already used
data[].left_quota string Remaining quota available
message string Response message

Loanable Orders

Parameter Name Type Mandatory Limit Description
currency string N - Currency: USDT 
curl -X 'GET' \
  'https://mapi.matrixport.com/fixed-income/api/v3/tokenize/loanable_orders?currency=USDT' \
  -H 'accept: application/json' \

{
  "code": 0,
  "data": [
    {
      "id": "7420326983181217792",
      "user_id": "605788",
      "order_status": 4,
      "original_amount_dec": "10000",
      "amount_dec": "10000",
      "liquidation_principal_dec": "0",
      "currency": "USDT",
      "start_closed_time": 1768896000,
      "end_closed_time": 1769673600,
      "ror": 10000000,
      "coupon": null,
      "real_ror": "0.1",
      "original_ror": 10000000,
      "tokenize_id": "",
      "can_redeem": true,
      "tenor_day": 6.128611111111111,
      "product_id": "7420326880596930560",
      "cell_no": "7351548916653035520",
      "left_tenor": 7,
      "loan_apy": "0.12",
      "max_loan": "9000",
      "min_loan": "0.01",
      "allocated_loan": "0",
      "real_loan_rate": "0",
      "ltv": "0.9",
      "total_quota": "2000000000",
      "used_quota": "5000",
      "left_quota": "46361934.972699529180693652",
      "day_interest": "2.95890410958904109589041095890411",
      "hour_interest": "0.12328767123287671232876712328767",
      "LoanSymbol": {
        "collateral_currency": "MFIP-USDT",
        "loan_currency": "USDT",
        "interest_rate": "0.1"
      }
    }
  ],
  "message": ""
}
Parameter Name Type Description
code integer Response code (0 for success)
data array Array of loanable order information
data[].id string Order ID
data[].user_id string User ID
data[].order_status integer Order status
data[].original_amount_dec string Original investment amount
data[].amount_dec string Current investment amount
data[].liquidation_principal_dec string Liquidation principal amount
data[].currency string Currency code (e.g., "USDT")
data[].start_closed_time integer Close start time (Unix timestamp)
data[].end_closed_time integer Close end time (Unix timestamp)
data[].ror integer Rate of return, e8
data[].coupon object/null Coupon information (null if not applicable)
data[].real_ror string Real rate of return
data[].original_ror integer Original rate of return, e8
data[].tokenize_id string Tokenize ID
data[].can_redeem boolean Whether the order can be redeemed
data[].tenor_day number Tenor in days
data[].product_id string Product ID
data[].cell_no string Cell number identifier
data[].left_tenor integer Remaining tenor in days
data[].loan_apy string Loan APY
data[].max_loan string Maximum loan amount
data[].min_loan string Minimum loan amount
data[].allocated_loan string Allocated loan amount
data[].real_loan_rate string Real loan rate
data[].ltv string Loan-to-value ratio
data[].total_quota string Total quota available
data[].used_quota string Amount of quota already used
data[].left_quota string Remaining quota available
data[].day_interest string Daily interest amount
data[].hour_interest string Hourly interest amount
data[].LoanSymbol object Loan symbol information
data[].LoanSymbol.collateral_currency string Collateral currency
data[].LoanSymbol.loan_currency string Loan currency
data[].LoanSymbol.interest_rate string Interest rate
message string Response message

Loan Calculate

Parameter Name Type Mandatory Limit Description
LANGUAGE-TYPE string N - Language type: en
currency string Y - Currency: USDT
loan_amount number Y - Loan amount: 10 
curl -X 'POST' \
  'https://mapi.matrixport.com/fixed-income/api/v3/tokenize/loan/calculate' \
  -H 'accept: application/json' \
  -H 'LANGUAGE-TYPE: en' \
  -H 'Content-Type: application/json' \
  -d '{
  "currency": "USDT",
  "loan_amount": 10
}'

{
  "code": 0,
  "data": [
    {
      "id": "7420326983181217792",
      "user_id": "605788",
      "order_status": 4,
      "original_amount_dec": "10000",
      "amount_dec": "10000",
      "liquidation_principal_dec": "0",
      "currency": "USDT",
      "start_closed_time": 1768896000,
      "end_closed_time": 1769673600,
      "ror": 10000000,
      "coupon": null,
      "real_ror": "0.1",
      "original_ror": 10000000,
      "tokenize_id": "",
      "can_redeem": true,
      "tenor_day": 6.127534722222222,
      "product_id": "7420326880596930560",
      "cell_no": "7351548916653035520",
      "left_tenor": 7,
      "loan_apy": "0.12",
      "max_loan": "9000",
      "min_loan": "0.01",
      "allocated_loan": "10",
      "real_loan_rate": "0.001",
      "ltv": "0.9",
      "total_quota": "2000000000",
      "used_quota": "5000",
      "left_quota": "46361935.086485973261480129",
      "day_interest": "0.00328767123287671232876712328767",
      "hour_interest": "0.00013698630136986301369863013699",
      "LoanSymbol": {
        "collateral_currency": "MFIP-USDT",
        "loan_currency": "USDT",
        "interest_rate": "0.1"
      }
    }
  ],
  "message": ""
}
Parameter Name Type Description
code integer Response code (0 for success)
data array Array of calculated loan information
data[].id string Order ID
data[].user_id string User ID
data[].order_status integer Order status
data[].original_amount_dec string Original investment amount
data[].amount_dec string Current investment amount
data[].liquidation_principal_dec string Liquidation principal amount
data[].currency string Currency code (e.g., "USDT")
data[].start_closed_time integer Close start time (Unix timestamp)
data[].end_closed_time integer Close end time (Unix timestamp)
data[].ror integer Rate of return, e8
data[].coupon object/null Coupon information (null if not applicable)
data[].real_ror string Real rate of return
data[].original_ror integer Original rate of return, e8
data[].tokenize_id string Tokenize ID
data[].can_redeem boolean Whether the order can be redeemed
data[].tenor_day number Tenor in days
data[].product_id string Product ID
data[].cell_no string Cell number identifier
data[].left_tenor integer Remaining tenor in days
data[].loan_apy string Loan APY
data[].max_loan string Maximum loan amount
data[].min_loan string Minimum loan amount
data[].allocated_loan string Allocated loan amount
data[].real_loan_rate string Real loan rate
data[].ltv string Loan-to-value ratio
data[].total_quota string Total quota available
data[].used_quota string Amount of quota already used
data[].left_quota string Remaining quota available
data[].day_interest string Daily interest amount
data[].hour_interest string Hourly interest amount
data[].LoanSymbol object Loan symbol information
data[].LoanSymbol.collateral_currency string Collateral currency
data[].LoanSymbol.loan_currency string Loan currency
data[].LoanSymbol.interest_rate string Interest rate
message string Response message

Create Loan

Parameter Name Type Mandatory Limit Description
currency string Y - Currency: USDT
fixed_income_order_ids array Y - Array of fixed income order IDs
loan_amount number Y - Loan amount: eg., 10
loan_distribution_channel number Y - Loan distribution channel: 2 (MPBrokerAccount) 
curl -X 'POST' \
  'https://mapi.matrixport.com/fixed-income/api/v3/tokenize/loan' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "currency": "USDT",
  "fixed_income_order_ids": [
    "7420326983181217792"
  ],
  "loan_amount": 10,
  "loan_distribution_channel": 2
}'

{
  "code": 0,
  "data": [
    {
      "fixed_income_order_id": "7420326983181217792",
      "tokenize_id": "7420329567900086273"
    }
  ],
  "message": ""
}
Parameter Name Type Description
code integer Response code (0 for success)
data array Array of loan creation results
data[].fixed_income_order_id string Fixed income order ID
data[].tokenize_id string Tokenize ID for the created loan
message string Response message

Loan Result

Parameter Name Type Mandatory Limit Description
tokenize_id_list array Y - Array of tokenize IDs to query 
curl -X 'POST' \
  'https://mapi.matrixport.com/fixed-income/api/v3/tokenize/loan/result' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "tokenize_id_list": [
    "7420329567900086273"
  ]
}'

{
  "code": 0,
  "data": [
    {
      "id": "3591927160266598",
      "created_on": 1769144432,
      "modified_on": 1769144436,
      "order_id": "7420326983181217792",
      "user_id": "605788",
      "currency": "USDT",
      "token_symbol": "MFIP-USDT",
      "term": 7,
      "ror_dec": "0.1",
      "principal": "10000",
      "left_principal": "0",
      "seq": 0,
      "token_amount": "10000",
      "pledged_token_amount": "10000",
      "burned_token_amount": "0",
      "order_token_status": 4,
      "tokenize_id": "7420329567900086273",
      "serial_number": "7420329567900086272",
      "collateral_order_id": "7420329583024746496",
      "loan_amount": "10",
      "loan_distribution_channel": 2,
      "end_closed_time": 1769673600,
      "can_redeem": true,
      "settle_unfreeze_sn": "",
      "settled_amount": "0",
      "loan_order": {
        "order_id": "7420329583024746496",
        "status": 400,
        "interest_rate": "0.12",
        "loan_amount": "10",
        "collateral_amount": "10000",
        "remaining_principal": "10",
        "total_interest": "0.01",
        "remaining_interest": "0.01",
        "start_interest_time": 1769144400000,
        "end_interest_time": 4828176000000
      }
    }
  ],
  "message": ""
}
Parameter Name Type Description
code integer Response code (0 for success)
data array Array of loan result information
data[].id string Record ID
data[].created_on integer Creation timestamp
data[].modified_on integer Modification timestamp
data[].order_id string Fixed income order ID
data[].user_id string User ID
data[].currency string Currency code (e.g., "USDT")
data[].token_symbol string Token symbol (e.g., "MFIP-USDT")
data[].term integer Term in days
data[].ror_dec string Rate of return
data[].principal string Principal amount
data[].left_principal string Remaining principal amount
data[].seq integer Sequence number
data[].token_amount string Token amount
data[].pledged_token_amount string Pledged token amount
data[].burned_token_amount string Burned token amount
data[].order_token_status integer Order token status: 1(wait_to_mint), 2(wait_to_pledge), 3(pledged), 4(loan_released), 5(repaying), 6(wait_to_burn), 61(wait_to_un_pledge), 7(burned)
data[].tokenize_id string Tokenize ID
data[].serial_number string Serial number
data[].collateral_order_id string Collateral order ID
data[].loan_amount string Loan amount
data[].loan_distribution_channel integer Loan distribution channel
data[].end_closed_time integer End closed time (Unix timestamp)
data[].can_redeem boolean Whether the order can be redeemed
data[].settle_unfreeze_sn string Settlement unfreeze serial number
data[].settled_amount string Settled amount
data[].loan_order object Loan order details
data[].loan_order.order_id string Loan order ID
data[].loan_order.status integer Loan order status: 0(InvalidOS - pending loan), 1(InitOS - awaiting approval), 100(AuditSucceedOS - awaiting pledge), 110(OrderClosedOS - canceled), 200(PledgeSucceedOS - awaiting disbursement), 400(LoanSucceedOS - pending repayment), 600(PledgeSettledOS - settled)
data[].loan_order.interest_rate string Interest rate
data[].loan_order.loan_amount string Loan amount
data[].loan_order.collateral_amount string Collateral amount
data[].loan_order.remaining_principal string Remaining principal
data[].loan_order.total_interest string Total interest
data[].loan_order.remaining_interest string Remaining interest
data[].loan_order.start_interest_time integer Start interest time (milliseconds timestamp)
data[].loan_order.end_interest_time integer End interest time (milliseconds timestamp)
message string Response message

BalanceRepayMax

Parameter Name Type Mandatory Limit Description
order_id string Y - Order id (loan_order.order_id)
repay_currency string Y - Repay currency 
curl "https://mapi.matrixport.com/collateral-lending/api/v1/repay/balance-repay-max"

{
  "code": 0,
  "data": {
    "exchange_rate": 0,
    "loan_currency": "string",
    "loan_max_amount": 0,
    "repay_currency": "string",
    "repay_max_amount": 0
  },
  "message": "string"
}
Parameter Name Type Description
exchange_rate decimal Exchange rate
loan_currency string Loan currency
loan_max_amount decimal Loan max amount
repay_currency string Repay currency
repay_max_amount decimal Repay max amount

BalanceRepay

Parameter Name Type Mandatory Limit Description
order_id string Y - Order id (loan_order.order_id)
repay_amount decimal Y - Repay amount
repay_currency string Y - Repay currency 
curl "https://mapi.matrixport.com/collateral-lending/api/v1/repay/balance-repay"

{
  "code": 0,
  "data": {
    "order_id": "string",
    "serial_no": "string"
  },
  "message": "string"
}
Parameter Name Type Description
order_id string Order id
serial_no string Serial no.

BalanceRepayResult

Parameter Name Type Mandatory Limit Description
order_id string Y - Order id (loan_order.order_id)
serial_no string Y - Serial no. 
curl "https://mapi.matrixport.com/collateral-lending/api/v1/repay/balance-repay-result"

{
  "code": 0,
  "data": {
    "real_repay_amount": 0,
    "real_repay_currency": "string",
    "status": 0,
    "transfer_repay_amount": 0,
    "transfer_repay_currency": "string"
  },
  "message": "string"
}
Parameter Name Type Description
real_repay_amount decimal Real repay amount
real_repay_currency string Real repay currency
status RepayResultStatus RepayResultStatus
transfer_repay_amount decimal Should repay amount
transfer_repay_currency string Should repay currency

ModelDefinition

RepayResultStatus

Name Value Description
RepayResultStatusRepaying 1 Repaying
RepayResultStatusRepaidUnPayOff 2 Repaid, unsettled
RepayResultStatusRepaidPayOff 3 Repaid, settled
RepayResultStatusFailed 4 Repay failed

Error Codes

Return Codes Details
0 OK.
17002001 Parameter error.
17002012 Invalid interface authorization.
17002011 Restricted IP.
17002010 Signature error.
17002013 Invalid akid.
1203001 Internal error.
1203002 Failed to cancel.
1203003 Product is not undergoing collection.
1203004 Product is still undergoing collection.
1203005 Login required.
1203006 Cannot generate pending settlement status. Current order is not processing.
1203007 Insufficient value remaining.
1203008 Request frequency too high.
1203009 Insufficient product(s).
12030010 Exceeds purchase limit.
12030011 Minimum purchase amount not met.
12030012 Cannot purchase at this time.
12030013 Cannot auto-renew normal products.
12030014 Cannot auto-renew this product, or this product is not available for purchase.
12030015 Cannot purchase auto-renew products.
12030016 Cannot make duplicate auto-renew requests.
12030017 Cannot send auto-renew request. Order is not pending.
12030018 Cannot send auto-renew request. Closing end time for the order must be earlier than the closing start time for auto-renew productions.
12030019 Cannot send auto-renew request. You must use the same currency as the order.
12030020 Order is not pending.
12030021 Product is not redeemable.
12030022 You may only view your own orders.
12030023 Exceeds individual purchase limit.
12030024 Cannot update auto-renew status. Order must be processing, holding, pending calculation, or on preorder to perform this operation.
12030025 This product does not support auto-renewal.
12030030 Unable to change auto-renewal product limit at this time.
12030031 Cannot redeem. Redeem value exceeds the total order cost.
12030033 Invalid coupon.
12030034 Current batch is no longer undergoing collection. Please wait for the next batch.
12030035 Redeeming current order.
12030036 No auto-renew products found.
12030037 Unable to auto-renew order at this time.
Example