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)
transactionTypeEnumNoCREDIT, ADJUSTMENT, REWARD (Default: CREDIT)
descriptionStringYesTransaction remarks / justification
referenceNoStringNoBank/Payment reference number
paymentModeStringNoPayment mode (e.g. "NEFT", "UPI", "CHEQUE")

Request Body Example​

{
"companyId": "c478a846-993d-4c8d-bf8d-d77cb3370e01",
"amount": 100000.00,
"transactionType": "CREDIT",
"description": "Quarterly Credit Top-Up",
"referenceNo": "REF-BANK-998877",
"paymentMode": "NEFT"
}

Response Example (200 OK)​

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