API Reference

Console Configuration

If you are using the Map3 Supercharge SDK to connect your users to their Binance.com account, you will need to provide a few fields in the Console Settings.

Order APIs

REST API

GET ORDER

curl -X GET "https://api.map3.xyz/console/v1/orders/$ORDER_ID" \
    -H  "Accept: application/json" \
    -H  "Authorization: Bearer $MAP3_API_KEY" \
    -H 'Content-Type: application/json' 

GET ORDERS

curl -X GET "https://api.map3.xyz/console/v1/orders" \
    -H  "Accept: application/json" \
    -H  "Authorization: Bearer $MAP3_API_KEY" \
    -H 'Content-Type: application/json' 

Query Parameters

The following optional query parameters can help you narrow the range of the historical orders. The sorting is in descending order.

ParametersTypeDescription
limitintegerThe number of orders to return. Default 100, limit 200.
offsetintegerThe number of orders to skip in the result. Default 0.
platform_transaction_idstringThe platform transaction id of the order.
platform_prepay_idstringThe platform prepay id of the order.
platform_merchant_trade_nostringThe platform merchant trade number id of the order.

Webhook

You can also receive webhook updates for your order. To start receiving webhooks:

  1. Visit https://console.map3.xyz/settings
  2. Click Webhook Portal in the Binance section.
  3. Configure your webhook url handler.

Order Model

Our REST and Webhook APIs share the following Order Object Model:

FieldTypeDescription
idstringOrder ID
statusnull || 'initial', 'pending', 'paid', 'canceled', 'error', 'refunding', 'refunded', 'expired'.Order State
asset_idstringMap3 Asset ID
amountnumberAmount of the order in minor units.
platform_transaction_idstringThe unique identifier of the Binance Pay transaction once the payment settles.
platform_prepay_idstringUnique identifier for the Binance Pay prepayment.
platform_merchant_trade_nostringUnique identifier for the order that is passed on to Binance Pay. Useful for reconciliation purposes in addition to order.id.
platform'binance-pay'
type'deposit', 'withdrawal'