Skip to main content

Overview

The Wallet API provides endpoints for managing partner-scoped customer wallets, including balance queries, transaction history, daily limits, and virtual account management.
All wallet endpoints require customer authentication (Bearer token) in addition to partner credentials.
Complete API Specification: View the full SSO OpenAPI Spec for detailed schemas and all endpoint specifications.

Wallet Endpoints

Get or Create Wallet

GET /sso/wallet - Get or create partner-scoped wallet

Transaction History

GET /sso/wallet/history - Get paginated transaction history

History by Reference

GET /sso/wallet/history/{reference} - Get history for specific reference

Wallet Summary

GET /sso/wallet/summary - Get wallet summary by categories

Daily Limits

GET /sso/wallet/limit - Get daily transaction limits and spend

Virtual Accounts

GET /sso/wallet/v-account - Get wallet virtual accounts

Key Features

Partner-Scoped Wallets

Each partner gets isolated wallet instances for their customers. The wallet is automatically created if it doesn’t exist on first request.

Transaction History

Comprehensive filtering options:
  • Date range filtering
  • Transaction type and status
  • Search by reference
  • Pagination support

Daily Limits

Check available limits before transactions to provide better UX and avoid failed transactions.

Virtual Accounts

Virtual accounts allow customers to fund their wallets via bank transfer. Accounts are automatically created on first request.

Wallet Guide

Implementation examples

Transactions API

Process payments and transfers

Integration Guide

Complete implementation guide

OpenAPI Spec

Full API specification

Security

All wallet endpoints require:
  • x-client-id header (Partner ID)
  • x-api-key header (Partner API key)
  • Authorization: Bearer {customer_token} header

Error Responses

API Tags

The Wallet API includes endpoints under the SSO Wallet tag in the OpenAPI specification.
For complete request/response schemas, parameters, and examples, refer to the SSO OpenAPI Specification.