Changelog
Changes to the Orbita API, newest first.
Bank list Rolling out
- New: List banks —
GET /api/banks?currency=ngnreturns the banks you can pay out to, with thebankCodeto send asdestinationBankCode.
Rates and quotes — breaking changes
- Breaking: rate objects from List rates and Get a pair rate now have
buyRateandsellRate, both quoted the way people quote rates.rate,displayRateandsellRateDisplayare removed — usebuyRatewhere you useddisplayRate.sellRatechanges meaning: it was the raw reverse rate and is now the quoted one. The pair lookup no longer returnsid. - List rates lists each currency pair once, base currency first (e.g. usd→ngn), instead of both directions.
- Breaking: quotes from List quotes no longer include
idorusedAt. Usecodeto identify a quote. - List quotes drops a quote as soon as it expires or is used. Previously it could still appear for a while afterwards.
Sub-wallets, payments received and webhooks Rolling out
- New: Create a sub-wallet —
POST /api/sub-walletsgives one of your customers their own NGN account number. Payments into it are credited to your NGN balance. - New: list, get and totals endpoints, with how much each sub-wallet has received.
- New: refresh status, deactivate and reactivate.
- New: List payments received, Get a payment and Resend a payment webhook.
- New: Webhooks — signed
virtual_account_fundingandsub_wallet_provisionedevents, set up under Settings → Webhooks.
Buy/sell rates and cross-currency payouts Rolling out
- New: Get a currency pair rate —
GET /api/rates?fromCurrency=…&toCurrency=…returns one pair withrateTimestampandvalidUntil. - Cross-currency payouts: Create a payout with different
sourceCurrencyanddestinationCurrencyconverts and pays out in one call. (This replaces the separatePOST /api/payouts/cross-currencyendpoint announced earlier in this release.) Responses now includetype:payoutorcross_currency. - Payout
statusis now only everqueued,pending,successfulorfailed. Internal review stages all show aspending. - Create a payout returns
409if another request with the samecustomerReferenceis still being processed, or if theconversionIdalready funds another payout.bankCountryandrecipientCountrymust be supported countries. - Rate-limited requests (
429) now return a readable message instead ofThrottlerException: Too Many Requests. - Conversions include
payoutIntent, showing the status of an attached cross-currency payout. - Payouts include
conversionId, and List payouts can filter by it.
Current API
Available to all API customers:
- Rates: List rates.
- Quotes: List quotes.
- Conversions: create, list and get.
- Payouts: create, list and get by ID or customerReference.
- Security: API keys, IP allowlisting, per-key rate limits, request signing and signed responses.
