Create an order

POST/v3/orders/:orderId

Description

Create an order using the payload. If due to the user’s location there’s a restriction in the swap, it will return an error instead.

Header Parameters

Name	Description	Required
App-Name	App-Name for the authorization	yes
App-Version	App-Version for the authorization	no
Forwarded	If you are proxying requests to the API, you must include the "Forwarded" header with the original request IP address. This is used for geolocation availability purposes.	no

Payload

Name	Description	Required
fromAmount	Amount the user is sending to exchange in the 'from' asset unit.	yes
fromAddress	Address from which the user is sending the funds.	yes
fromAddressTag	The tag/memo of the fromAddress. Only required for certain assets like ATOM, EOS, XRP, etc.	no
toAmount	The amount you want receive in the 'to' asset	yes
toAddress	The address to receive the exchanged funds	yes
toAddressTag	The tag/memo of the toAddress. Only required for certain assets like ATOM, EOS, XRP, etc.	no
pairId	The pair id for this exchange. Read the pairs documentation to find the correct one.	yes
slippage	Percentage of slippage tolerance with a 2% by default.	no

Response

SUCCESSFULL ORDER CREATION

{
  "amount": {
    "assetId": "BTC",
    "value": 0.47
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "fromAddress": "EJVsaNYRzo1GVhzrmYM5WnxU9FUnBtibjKNAkkq9YaP2",
  "fromAddressTag": "string",
  "fromTransactionId": "37CUt9gzAGN8LcZ2haCFmioAXn2FPp9f7y",
  "id": "vQm7GDXboWw6NbL",
  "message": "string",
  "pairId": "BTC_ETH",
  "payInAddress": "37CUt9gzAGN8LcZ2haCFmioAXn2FPp9f7y",
  "payInAddressTag": "string",
  "providerOrderId": "6fkmegv6ce6mz68refdd",
  "rateId": "6d31e45a-daa8-4578-84da-9fedb3117c1f",
  "toAddress": "0x531a9aA0f2cF0F0B193d6Ca6aA9d990a54A2657a",
  "toAddressTag": "string",
  "toTransactionId": "0x531a9aA0f2cF0F0B193d6Ca6aA9d990a54A2657a",
  "updatedAt": "2019-08-24T14:15:22Z",
  "status": "awaiting",
  "extraFeatures": {
    "pid": "string",
    "stringAmounts": "string"
  }
}