Skip to content

Changelog ​

This documentation is maintained based on BFX · API Integration Documentation.

v1.1.0 · 2026 ​

  • Added the Prediction product. 01 / Integration Flow gains a "Products" note: both products share API credentials and wallet balance.
  • Site name changed from "BFX Exchange" to "BFX".
  • 2.4 Balance Query and 2.5 Wallet Transfer now use generic paths without a product prefix: /api/v1/user/wallets/{external_player_id}/balance, /deposit, /withdrawal, applying to both Exchange and Prediction; the original /api/v1/user/exchange/wallets/... paths still work.
  • 2.3 Login: added two entry points — /api/v1/user/sso/getkey (lobby menu where the player picks a product) and /api/v1/user/prediction/sso/getkey (straight to Prediction); the existing /api/v1/user/exchange/sso/getkey goes straight to Exchange.
  • 03 / Query APIs regrouped into Shared, Exchange, and Prediction, with the error reference moved to the end and sections renumbered (3.1 – 3.10).
  • 3.1 Wallet Ledger (formerly "Wallet Transfer Records") moved to GET /api/v1/wallet/report/ledger and applies to both Exchange and Prediction.
  • 3.2 Transaction Status Query moved to POST /api/v1/wallet/transfer-wallet-transaction/status and applies to both Exchange and Prediction; the original /api/v1/user/exchange/transfer-wallet-transactions/status path still works.
  • Added Prediction query APIs: 3.7 Order Details, 3.8 Trade Details, 3.9 Position Details.
  • 2.5 Wallet Transfer (Deposit / Withdraw): amount precision reduced from up to 8 decimal places to up to 2 decimal places.
  • 3.1 Wallet Ledger: added the kind and source_id_type enums, and noted that items[] is sorted by created_at in descending order.
  • 3.2 Transaction Status Query: added the id, source_id, source_id_type, order_ids, and kind response fields.
  • 3.3 Bet Ticket Query: added account_external_id and counter_party to trades[]; corrected trades[].usd_stake to describe the matched amount of the trade; noted that usd_unmatched drops to 0 once an order is cancelled; the order time range is now marked conditionally required.
  • Added 3.4 Bet Ticket Query (Incremental Sync) GET /api/v1/exchange/report/bets/changes: returns orders by change time (including later changes such as rollbacks and voiding) with cursor pagination, for merchants to sync bets incrementally. The former 3.4 – 3.9 move to 3.5 – 3.10.

v1.0.8 · 2026 ​

  • 2.1 Common Conventions: added a "Time Format" section — RFC3339 fractional-second digits are not fixed and must be parsed with a general-purpose parser; empty values are returned as null.
  • 2.5 Wallet Transfer (Deposit / Withdraw): added error codes 10040 (a request with the same ticket_id is in flight) and 10050 (same ticket_id sent with a different amount / currency).
  • 2.5 Wallet Transfer (Deposit / Withdraw): added "Idempotency and Deduplication Rules" — the dedup key includes the transaction type, amount and currency must match exactly, and X-Idempotency-Key plays no part in transfer idempotency.
  • 2.6 Common Integration Errors and 3.6 Query APIs Error Reference: added 10040 and 10050.
  • 3.1 Bet Ticket Query: clarified the semantics of settled_time and updated_at, added an "Order Level vs. Trade Level" section and how to query voided bets.
  • 3.2 Wallet Transfer Records: added the id, source_id, source_id_type, kind, and order_ids response fields, plus "order_ids Behavior" and "Incremental Reconciliation" sections.
  • 3.2 Wallet Transfer Records: corrected BET_CANCEL_VOID_REFUND to BET_CANCEL_REFUND, added ADMIN_CANCEL_REFUND and ADMIN_CANCEL_CLAWBACK, and marked RE_SETTLEMENT_PAYOUT / MARKET_SUSPEND_REFUND as reserved values.
  • 3.3 Transaction Status Query: clarified that 10030 covers both "does not exist" and "not yet posted", and added the rate-limit note.
  • Rate-limit notes across the query APIs now state explicitly that the quota is counted per api_key × endpoint.
  • 05 / FAQ: added 5.10 "How long after a rollback does re-settlement happen" and 5.11 "Final status when an event is cancelled".

v1.0.7 · 2026 ​

  • 3.1 Bet Ticket Query: completed the items[] and trades[] response fields, and added an amount calculation formula section.
  • 2.1 Login: added the lang request parameter (specifies the initial game UI language).
  • 2.5 Wallet Transfer (Deposit / Withdraw): added notes on transaction failure and refund handling.
  • 01 / Integration Flow: clarified that an agent is bound to a single currency, which cannot be changed after account creation.
  • 05 / FAQ: added 5.1 "Which languages are currently supported".
  • 05 / FAQ: added 5.9 "Sports Prediction Market Rules" (price as probability, settlement, three steps, commission calculation).

v1.0.6 · 2026 ​

v1.0.5 · 2026 ​

  • Expanded 1.1 Submit Application: added a complete application checklist including master agent / agent details, wallet type, currency, IP allowlist, and how account-creation details are returned.
  • Added 1.1.1 IP Allowlist Notes: distinguishes the front-end (machine integration) and back-end (staff login) allowlists, with CIDR format notes.

v1.0.4 · 2026 ​

  • Expanded the supported currency list (added LKR, PKR, KES, INR, ZAR, HKD, PGK, AUD, CAD, NZD, SGD, EUR, GBP, and more).

v1.0.3 · 2026 ​

  • Login + Wallet APIs (Login, Balance Query, Deposit / Withdraw).
  • HMAC Signing Flow (JCS + SHA-256 + HMAC-SHA256).
  • Integration Flow, Currency Docs, and FAQ.

BFX · BE THE GAME CHANGER