Create a new gateway order.

Creates a new request, reserves the required liquidity.

post/v1/create-order

Request body

Response

Created order

Example response

{
  "onramp": {
    "order_id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
  }
}

Changes

Changed in 10 of the 19 revisions of this API.11112

May 26, 2026ca0ef15d58791See the full diff
- ○
  endpoint deprecated
  endpoint-deprecated
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 6, 2026162bab886181214See the full diff
- ▲
  removed the required property details/oneOf[GatewayErrorDetails]/oneOf[subschema #3 -> subschema #8]/min_required_sats from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property details/oneOf[GatewayErrorDetails]/oneOf[subschema #3 -> subschema #8]/sender from the response with the 400 status
  response-required-property-removed
- ●
  added the new QUOTE_AMOUNT_TOO_LOW enum value to the code response property for the response status 400
  response-property-enum-value-added
- ○
  the endpoint scheme security api_key was added to the API
  api-security-added
- ○
  removed the INSUFFICIENT_FUNDS enum value from the code response property for the response status 400
  response-property-enum-value-removed
- ○
  added the required property details/oneOf[GatewayErrorDetails]/oneOf[subschema #3 -> subschema #8]/actual to the response with the 400 status
  response-required-property-added
- ○
  added the required property details/oneOf[GatewayErrorDetails]/oneOf[subschema #3 -> subschema #8]/minimum to the response with the 400 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 20, 20263d71e0aeceec1See the full diff
- ○
  added the non-success response with the status 400
  response-non-success-status-added
Mar 16, 2026b1e4042458211See the full diff
- ▲
  added the new required request property oneOf[subschema #1]/onramp/signedQuoteData
  new-required-request-property
Mar 11, 2026e9e15c4bb4b72See the full diff
- ▲
  the response property oneOf[subschema #1]/onramp/psbt_hex became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property oneOf[subschema #1]/onramp/psbt_hex became optional for the status 201
  response-property-became-optional
Mar 5, 2026a6065adb7d7411See the full diff
- ▲
  removed subschema #1 subschema #2 subschema #3 from the request body oneOf list
  request-body-one-of-removed
- ○
  added subschema #1 subschema #2 subschema #3 to the request body oneOf list
  request-body-one-of-added
Mar 5, 20262e78148bdade11See the full diff
- ▲
  removed subschema #1 subschema #2 subschema #3 from the request body oneOf list
  request-body-one-of-removed
- ○
  added subschema #1 subschema #2 subschema #3 to the request body oneOf list
  request-body-one-of-added
Feb 27, 2026a0817a4b88f911See the full diff
- ▲
  added the new required request property oneOf[subschema #3]/layerZero/recipient
  new-required-request-property
- ○
  added the new optional request property oneOf[subschema #3]/layerZero/sender
  new-optional-request-property
Feb 24, 202666520595571611See the full diff
- ▲
  removed subschema #1 subschema #2 subschema #3 from the request body oneOf list
  request-body-one-of-removed
- ○
  added subschema #1 subschema #2 subschema #3 to the request body oneOf list
  request-body-one-of-added
Feb 20, 20268b8f903ea7dd22See the full diff
- ▲
  removed subschema #1 subschema #2 subschema #3 from the request body oneOf list
  request-body-one-of-removed
- ▲
  added subschema #2 subschema #3 to the response body oneOf list for the response status 201
  response-body-one-of-added
- ○
  added subschema #1 subschema #2 subschema #3 to the request body oneOf list
  request-body-one-of-added
- ○
  removed subschema #2 subschema #3 from the response body oneOf list for the response status 201
  response-body-one-of-removed
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history