The Partner API enables external systems like VULT to interact with OLIVE wallets. All requests require HMAC-SHA256 signature authentication.
Integration Partners
VULT
Mobile money integration for wallet funding
Banks
Bank transfer integrations
Custom
Custom partner integrations
Endpoints
Account Status
POST /api/v1/partner/account-statusCheck if subscriber account existsTransaction History
POST /api/v1/partner/transaction-historyGet partner’s transaction historyCash In
POST /api/v1/partner/cashinCredit subscriber walletAuthentication
Partner API uses HMAC-SHA256 signature authentication instead of Bearer tokens.- Required Headers
- Signature Generation
- Full Request
Cash-In Flow
1
Lookup Subscriber
Partner calls
account-status to verify subscriber exists2
Initiate Cash-In
Partner sends
cashin request with amount and reference3
Account Credited
Subscriber wallet is immediately credited
4
Partner Debited
Partner clearing account is debited (can go negative)
5
Confirmation
Transaction ID returned for reconciliation
Response Examples
- Account Status
- Cash-In Success
- Transaction History
Error Handling
Integration Checklist
Development
- Obtain
X-API-Key-ID, partner ID, and HMAC secret - Implement signature generation
- Test with sandbox environment
- Handle all error responses
Production
- Request production credentials
- Set up webhook receivers
- Configure reconciliation process
- Enable monitoring/alerting