Skip to main content

​
API release history

Use this page to review endpoint-level changes across versions.
When you update endpoint behavior or endpoint-facing documentation, add a new release entry at the top of this page before you merge your pull request.
​
v1.0.2
Released 2026-02-12

​
Added

  • GET /v1/accounts: Added optional scope query filter with values default and shortcode.

​
Changed

  • GET /v1/accounts: Clarified that type (collections or payouts) remains supported and can be combined with scope in the same request.
  • GET /v1/accounts: Documented scope semantics (default returns accounts where shortcodeId is absent, shortcode returns accounts where shortcodeId is present) and confirmed that omitted filters return all non-system accounts.

​
Impact

  • Backward compatibility: non-breaking
  • Integrator action required: Optional. Use scope when you need shortcode-based segmentation in account listing responses.

​
References

  • PR: Pending merge
  • Commit(s): Pending merge commit hash
​
v1.0.1
Released 2026-02-12

​
Added

  • GET /v1/transactions: Added optional enterprise shortcode query filter to return only transactions routed through a specified organization shortcode.

​
Changed

  • GET /v1/balance: Clarified and documented that accountNo is required.
  • GET /v1/balance: Documented request validation behavior for missing accountNo and legacy account-only requests (400 response).
  • GET /v1/balance: Documented precedence rule when both accountNo and legacy account are sent (accountNo takes precedence).

​
Impact

  • Backward compatibility: breaking for clients relying on legacy account-only balance queries
  • Integrator action required: Update all GET /v1/balance calls to always include accountNo; do not rely on legacy account as the primary selector

​
References

  • PR: Pending merge
  • Commit(s): Pending merge commit hash
​
v1.0.0
Initial public documentation baseline

​
Added

  • Published endpoint documentation for payments, payouts, accounts, and transactions.
  • Published webhook documentation and event model coverage for asynchronous updates.

​
Impact

  • Backward compatibility: non-breaking
  • Integrator action required: None

​
References

  • PR: Baseline documentation release
  • Commit(s): Initial repository endpoint docs history

​
Entry template

Copy this block for your next release entry and place it above older entries. 
<Update label="vX.Y.Z" description="Released YYYY-MM-DD">
## Added
- `METHOD /path`: Describe any additive change.

## Changed
- `METHOD /path`: Describe what changed and why.

## Deprecated
- `METHOD /path`: Describe deprecation timeline and replacement.

## Removed
- `METHOD /path`: Describe removal and migration path.

## Fixed
- `METHOD /path`: Describe corrected behavior and impact.

## Security
- `METHOD /path`: Describe security update and required actions.

## Impact
- Backward compatibility: `non-breaking` or `breaking`
- Integrator action required: `None` or list required actions

## References
- PR: #123
- Commit(s): abc1234
</Update>