Skip to main content

​
Prerequisites

  • Contact Rails on Telegram to request API access: https://t.me/Oxbryte
  • A Rails API key issued manually
  • A backend that can store your order IDs
  • A webhook endpoint or polling loop
  • At least one supported token and fiat corridor

​
First integration steps

  1. Contact https://t.me/Oxbryte and request an API key.
  2. Wait for manual key issuance.
  3. Fetch supported currencies with /v1/currencies.
  4. Fetch payout institutions with /v1/institutions/{currency_code}.
  5. Fetch a rate with /v1/rates/{token}/{amount}/{fiat}.
  6. Create an offramp order.
  7. Register a webhook and watch for settlement updates until payout completes.

​
Implementation rule

Keep the order lifecycle in your own database. Rails should be the system of record for settlement state, but your app should persist:
  • the order reference
  • the user reference
  • the quoted amount
  • the selected corridor
  • the current state