REST API v1

Changelog

Find all our API improvements here in one place. Rest assured that any updates will be made in a backwards-compatible way, so you don't have to update your existing API client code.

✍️ July 21th 2024

  • Add bitcoin sell order creation
  • Add lightning sell order creation

✍️ June 18th 2024

  • Add lightning_address to Order resource for automatic lightning payouts
  • Update the payout resource to always include the failure_code field for both invoice and channel payouts. In case this field was previously omitted, null is now returned instead.
  • Update the payout resource to always include the node_address, txid, outpoint, channel_id for channel payouts. In case those fields were previously omitted, null is now returned instead.

✍️ February 14th 2024

  • Add type to Order resource

⚡️ May 8th 2023

  • Add Lightning node_pubkey payout method to Order resource
  • Add payout type to Exchange resource and webhooks
  • Add Lightning payout status to Exchange resource and webhooks
  • Add Lightning payout invoice to Exchange resource and webhooks
  • Add (optional) Lightning payout preimage to Exchange resource and webhooks
  • Add (optional) Lightning payout failure_code to Exchange resource and webhooks
  • Add (optional) Lightning payout host to Exchange resource and webhooks

✍️ January 23rd 2023

  • Add GBP currency support

✍️ April 23rd 2022

  • Introduce optional Order affiliate_id field

✍️ January 26th 2022

  • Expose Order active status
  • Introduce Order patch method

🔑 January 9th 2022

  • Introduce the Challenge resource

☀️ September 29th 2021

  • Initial version