Skip to main content

Credit Company Wallet API

Overview

Credits funds/limit to a company wallet and logs a ledger transaction.

  • Endpoint: /api/wallet/credit
  • Method: POST

Request Body Schema

FieldTypeRequiredDescription
companyIdString (UUID)YesTarget company ID
amountNumberYesCredit amount (> 0)
descriptionStringNoTransaction remarks
referenceNumberStringNoBank/Payment reference number

Request Body Example

{
"companyId": "comp_12345678",
"amount": 100000.00,
"description": "Quarterly Credit Top-Up",
"referenceNumber": "REF-BANK-998877"
}

Response Example (200 OK)

{
"success": true,
"data": {
"walletId": "wlt_11223344",
"balance": 600000.00,
"transactionId": "txn_55667788"
},
"message": "Company wallet credited successfully"
}