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

Changelogs

version time content
V1.0.0
2022-05-27
 initial version

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)

API hosts (beta)

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-MatrixPort-Access-Key string Y 32 Access-Key given to users is contained within the http header.
X-MatrixPort-Access-Signature string Y - Request signature is used to authorize the legitimacy of the request. Contained within the http header.
timestamp int64 Y - Millisecond timestamp is contained within the http query param or body.
language-type int Y - Language type within the interface will return according to: 0=CN, 1=EN, 2= RU
x-request-id string N - Globally unique trace id, used for tracing requests

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
        "renew_type": 0, //integer, 0: can be manually-renewed; 1: can be automatically-renewed
        "currency": "USDT", //string, Investment currency
        "minimum_of_purchase_amount_dec": "100", //decimal, Minimum single transaction 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, Annual interest for early redemption, e8
        "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;
        "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
          "settle_limit": 0, //integer, Settlement Limit;0: No limit,1:Excludes weekends
        },
        "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.renew_type integer 0: can be manually-renewed; 1: can be automatically-renewed
items.currency string Investment currency
items.minimum_of_purchase_amount_dec decimal Minimum single transaction amount;
items.maximum_of_purchase_amount_dec decimal Maximum single transaction amount
items.user_purchase_limit_dec decimal 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.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.duration.settle_limit integer Settlement Limit;0: No limit,1:Excludes weekends
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
    "renew_type": 0, //integer, 0: can be manually-renewed; 1: can be automatically-renewed
    "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
    "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
        "settle_limit": 0 //integer, Settlement Limit;0: No limit, 1: Excludes weekends
    },
    "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
renew_type integer 0: can be manually-renewed; 1: can be automatically-renewed
currency string Investment Currency
minimum_of_purchase_amount_dec decimal Minimum single transaction amount; initial investment amount
maximum_of_purchase_amount_dec decimal Maximum single transaction amount
user_purchase_limit_dec decimal Maximum single user purchase amount
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
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
duration.settle_limit integer Settlement Limit;0: No limit, 1: Excludes weekends
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 Products remaining；-1 indicates no limit
user_left_quota_dec decimal Products available to user；-1 indicates no limit
minimum_of_purchase_amount_dec decimal Minimum purchase amount
maximum_of_purchase_amount_dec decimal 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 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_min_settle_amount_dec": "301", //decimal, Estimated minimum settlement amount; Use the minimum revenue rate trial; Capital + closure period revenue collection period revenue + coupon profit
    "estimate_max_settle_amount_dec": "301", //decimal, Estimated maximum settlement amount; Use the maximum revenue rate trial; Capital + closure period revenue collection period revenue + coupon profit
    "estimate_settle_amount_dec": "301", //decimal, Estimated settlement amount；
    "estimate_min_profit_dec": "33184931", //decimal, Estimated minimum revenue; Use the minimum revenue rate trial; Closure period revenue + collection period revenue + coupon profit
    "estimate_max_profit_dec": "33184931", //decimal, Estimated maximum revenue; Use the maximum revenue rate trial; Closure period revenue + collection period revenue + coupon profit
    "estimate_profit_dec": "33184931", //decimal, Estimated Profit
    "demand_profit_dec": "3595890", //decimal, Collection Profit
    "coupon_profit_dec": "0", //decimal, Coupon Profit
    "estimate_min_invest_profit_dec": "29589041", //decimal, Estimated minimum closure profit
    "estimate_max_invest_profit_dec": "29589041", //decimal, Estimated maximum closure profit
    "currency": "USDT" //string, Currency
  }
}
Parameter Name Type Description
estimate_min_settle_amount_dec decimal Estimated minimum settlement amount; Use the minimum revenue rate trial; Capital + closure period revenue collection period revenue + coupon profit
estimate_max_settle_amount_dec decimal Estimated maximum settlement amount; Use the maximum revenue rate trial; Capital + closure period revenue collection period revenue + coupon profit
estimate_settle_amount_dec decimal Estimated settlement amount；
estimate_min_profit_dec decimal Estimated minimum revenue; Use the minimum revenue rate trial; Closure period revenue + collection period revenue + coupon profit
estimate_max_profit_dec decimal Estimated maximum revenue; Use the maximum revenue rate trial; Closure period revenue + collection period revenue + coupon profit
estimate_profit_dec decimal Estimated Profit
demand_profit_dec decimal Collection Profit
coupon_profit_dec decimal Coupon Profit
estimate_min_invest_profit_dec decimal Estimated minimum closure profit
estimate_max_invest_profit_dec decimal Estimated maximum closure profit
currency string Currency

Make Order

Parameter Name Type Mandatory Limit Description
product_id string Y 64 Product ID: 6820591484295766016
amount_dec decimal Y - Investment Amount
coupon_id integer N - Coupon ID
serial_number string N - Max length 32, unique serial_number provided by client, not mandatory 
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
  }
}
Parameter Name Type Description
serial_number string Serial number return in make order api

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
end_closed_time integer N - EndClosedTime of order in unix timestamp
only_need_count string N - Only obtains quantity needed. No data needs to be obtained, and the return data has only one count. 
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
            "batch_no": "FixedIncome301USDT2021-07-13_18:00:007212000000", //string, Batch number
            "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,
            "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
                "settle_limit": 0 //integer, Settlement Limit;0: No limit, 1: Excludes weekends
            },
            "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_renew": 0, //integer, Activate manual renewal? 0: No 1: Yes
            "is_auto_renew": 0, //integer, Activate auto renewal? 0: No 1: Yes; Priority is less than manual renewal.
            "renew_type": 0, //integer, Allow users to auto-renew? 0: No 1: Yes
            "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.batch_no string Batch number
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 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.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.duration.settle_limit integer Settlement Limit;0: No limit, 1: Excludes weekends
items.ror integer Real rate of return, e8
items.redeem_ror integer Redeem annual interest early
items.payback_dec decimal Actual settled, information flow or capital flow
items.redeem_principal_dec decimal Order capital returned
items.is_renew integer Activate manual renewal? 0: No 1: Yes
items.is_auto_renew integer Activate auto renewal? 0: No 1: Yes; Priority is less than manual renewal.
items.renew_type integer Allow users to auto-renew? 0: No 1: Yes
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 Redeeming Amount (amount pending approval and processing)
items.estimate_settle_amount_dec decimal 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
    "batch_no": "FixedIncome301USDT2021-07-13_18:00:007212000000", //string, Batch no
    "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
        "settle_limit": 0 //integer, Settlement Limit;0: No limit, 1: Excludes weekends
    },
    "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_renew": 0, //integer, Activate manual renewal? 0: No 1: Yes
    "is_auto_renew": 0, //integer, Activate auto renewal? 0: No 1: Yes; Priority is less than manual renewal.
    "renew_type": 0, //integer, Allow users to auto-renew? 0: No 1: Yes
    "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
batch_no string Batch no
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 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
duration.settle_limit integer Settlement Limit;0: No limit, 1: Excludes weekends
ror integer Real rate of return, e8
redeem_ror integer Redeem annual interest early
payback_dec decimal Actual settled, information flow or capital flow,
redeem_principal_dec decimal Order capital returned,
is_renew integer Activate manual renewal? 0: No 1: Yes
is_auto_renew integer Activate auto renewal? 0: No 1: Yes; Priority is less than manual renewal.
renew_type integer Allow users to auto-renew? 0: No 1: Yes
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 Redeeming Amount (amount pending approval and processing)
estimate_settle_amount_dec decimal Est. Settlement Amount (trial value based on investment information, for reference onl
can_renew_product_count integer Renewable Product Count

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
  }

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
            "renew_type": 0, //integer, 0: can be manually-renewed; 1: can be automatically-renewed
            "currency": "USDT", //string, Investment Currency
            "minimum_of_purchase_amount_dec": "0", //decimal, Minimum single transaction amount; initial investment amount,
            "maximum_of_purchase_amount_dec": "0", //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": 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
                "settle_limit": 0 //integer, Settlement Limit;0: No limit, 1: Excludes weekends
            },
            "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
    "redeem_demand_interest_dec": "0", //string, estimate demand profit

    "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
redeem_demand_interest_dec string estimate demand profit
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,
  "message": "",
  "data": {
    "redeem_orders": [ //object, successful redeemed orders
      {
        "id": 6996844215246463000, //int, redeem record id
       "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
      "redeem_demand_interest_dec": "0", //string, estimate demand profit

      "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
      }
    ],
    "redeeming_amount_dec": "50.0" //string, amount in redeeming
  }
}
Parameter Name Type Description
redeem_orders object successful redeemed orders
redeem_orders.id int redeem record id
redeem_orders.order_id string order id
redeem_orders.redeem_ror int redeem ror in E8
redeem_orders.redeem_amount_dec string estimate redeem amount will received
redeem_orders.profit_dec string estimate total profit
redeem_orders.coupon_profit_dec string estimate coupon profit
redeem_orders.redeem_principal_dec string redeem principal
redeem_orders.redeem_demand_interest_dec string estimate demand profit
redeem_orders.id int redeem id
redeem_orders.ror int redeem ror of order
redeem_orders.redeem_time int redeem time
redeem_orders.confirm_time int redeem confirm time
redeem_orders.redeem_currency string redeem currency
redeem_orders.status int redeem status; 1: Create a redemption order succeeded, 2: Redemption succeeded, 3: Redemption canceled, 4: Under review
redeeming_amount_dec string amount in redeeming

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 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 Min available
coupons.max_amount_dec decimal 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
}

Fixed-Income Public API

Apy List

curl "https://mapi.matrixport.com/fixed-income/api/v2/public/apy"


{
  "code": 0,
  "message": "",
  "data": {
    "apys": [
      {
        "currency": "USDT",
        "apy": "0.12", //decimal, apy
        "tenor": 5, //int, tenor of product
        "minimum_of_purchase_amount": "10", //decimal, minimum of purchase amount in one single purchase
        "maximum_of_purchase_amount": "2000", //decimal, maximum of purchase amount in one single purchase
        "maximum_order_count": 0 //int, maximum order count of one user
      },
    ]
  }
}
Parameter Name Type Description
data.apys.apy decimal apy
data.apys.tenor int tenor of product
data.apys.minimum_of_purchase_amount decimal minimum of purchase amount in one single purchase
data.apys.maximum_of_purchase_amount decimal maximum of purchase amount in one single purchase
data.apys.maximum_order_count int maximum order count of one user

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