Skip to main content
The Partner API enables external systems like VULT to interact with OLIVE wallets. All requests require HMAC-SHA256 signature authentication.
The interactive Mintlify playground is disabled for partner endpoints because these routes require custom HMAC headers and a signature over the exact raw JSON body. Use the copyable bash examples on each endpoint page.

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 exists

Transaction History

POST /api/v1/partner/transaction-historyGet partner’s transaction history

Cash In

POST /api/v1/partner/cashinCredit subscriber wallet

Authentication

Partner API uses HMAC-SHA256 signature authentication instead of Bearer tokens.
HeaderDescription
X-API-Key-IDPartner API key ID
X-Partner-IDYour partner identifier (for example VULT)
X-TimestampRFC3339 timestamp
X-SignatureHMAC-SHA256 signature
Signatures are only valid for 5 minutes from the timestamp. Ensure your server clock is synchronized.

Cash-In Flow

1

Lookup Subscriber

Partner calls account-status to verify subscriber exists
2

Initiate Cash-In

Partner sends cashin request with amount and reference
3

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

{
  "success": true,
  "exists": true,
  "status": "active"
}

Error Handling

StatusCodeDescription
400INVALID_REQUESTMissing or invalid parameters
401INVALID_SIGNATUREHMAC signature verification failed
401EXPIRED_TIMESTAMPTimestamp older than 5 minutes
404USER_NOT_FOUNDSubscriber not found
500TRANSACTION_FAILEDInternal processing error

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