Create preorder

POST https://exchange-core.whitebird.io/api/v1/merchant/orders/request

Request headers

Name	Type	Required	Description
x-api-key	String	Yes	Merchant security key

Request body

Type	Name	Required	Description
asset	Number	Yes	Requested amount for calculation. Should be positive
assetPosition	String	Yes	Exchange assetPosition
currencyPair	Object	Yes	Exchange currencyPair
orderType	String	Yes	Exchange orderType
externalOrderId	String	Yes	Order id from merchant system. Link between Whitebird and Merchant orders
limit	Number	No	See here
paymentToken	String	No	See here
providerType	String	No	See here
cryptoAddress	String	No	See here
bonus	Number	No	Additional field for internal bonus program. Not used for external merchants. Bonus based on crypto currency, should be < than crypto amount of operation

Response

JSON

{
  "id": "string",
  "asset": 100,
  "assetPosition": "INPUT",
  "currencyPair": {
    "fromCurrency": "USD",
    "toCurrency": "BTC"
  },
  "externalOrderId": "string",
  "orderType": "DEPOSIT",
  "exchangeType": "SELL",
  "limit": 100,
  "bonus": 0.1,
  "cryptoAddress": "string",
  "paymentToken": "UUID",
  "providerType": "ASSIST"
}

Example request

JSON

{
  "asset": 100,
  "assetPosition": "INPUT",
  "currencyPair": {
    "fromCurrency": "USD",
    "toCurrency": "BTC"
  },
  "externalOrderId": "1234-1234-1234",
  "orderType": "DEPOSIT",
  "limit": null,
  "bonus": null,
  "cryptoAddress": null,
  "paymentToken": null,
  "providerType": null
}

cURL

curl -X POST 'https://exchange-core.whitebird.io/api/v1/merchant/orders/request' \
  -H 'Content-Type: application/json' \
  -d '{
  "asset": 100,
  "assetPosition": "INPUT",
  "currencyPair": {
    "fromCurrency": "USD",
    "toCurrency": "BTC"
  },
  "externalOrderId": "1234-1234-1234",
  "orderType": "DEPOSIT",
  "limit": null,
  "bonus": null,
  "cryptoAddress": null,
  "paymentToken": null,
  "providerType": null
}'