ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

transactionrequests

API	Description
GET GetPendingTransactions?UserId={UserId}	No documentation available.
GET GetProcessedTransactions?UserId={UserId}	No documentation available.
POST CancelTransaction?TransactionRef={TransactionRef}&UserId={UserId}	No documentation available.
POST CancelUserTransactionRequests?UserId={UserId}&cancelAll={cancelAll}	No documentation available.
GET GetCancelledTransactions?UserId={UserId}	No documentation available.
GET GetTransactionRequestStatus?TransactionRef={TransactionRef}	No documentation available.
GET GetTransactionByTransactionRef?TransactionRef={TransactionRef}	No documentation available.
POST UploadDocument	No documentation available.
POST CreateTransactionRequest	No documentation available.

Voucher

API	Description
POST vouchers/lookup-recipient	No documentation available.
POST vouchers/purchase	No documentation available.
GET vouchers/user/{userId}?type={type}	No documentation available.
GET vouchers/history/{userId}	No documentation available.
GET vouchers/{voucherId}	No documentation available.
GET vouchers/number/{voucherNumber}	No documentation available.
POST vouchers/{voucherId}/cancel	No documentation available.
POST vouchers/generate-qr	No documentation available.
GET vouchers/active-qr/{voucherReference}	No documentation available.
POST vouchers/parse-qr	No documentation available.
POST vouchers/merchant/validate-qr	No documentation available.
POST vouchers/recipient/approve-transaction	No documentation available.
GET vouchers/merchant/check-approval/{approvalId}	No documentation available.
GET vouchers/recipient/pending-approval/{recipientUserId}	No documentation available.
POST vouchers/cleanup-expired-qr	No documentation available.
GET vouchers/qr-image/{transactionNumber}?size={size}	No documentation available.
GET vouchers/qr-base64/{transactionNumber}?size={size}	No documentation available.
POST vouchers/generate-qr-image?size={size}	No documentation available.
GET vouchers/qr-image-custom/{transactionNumber}?size={size}&darkColor={darkColor}&lightColor={lightColor}	No documentation available.

Account

API	Description
GET GetBanks	No documentation available.
GET GetCompanyBankingDetails	No documentation available.
GET GetBankingDetails?UserId={UserId}	No documentation available.
POST UpdateBankingDetails	No documentation available.
GET UserInfo	No documentation available.
POST Logout	No documentation available.
GET UserRole?UserId={UserId}	No documentation available.
GET ManageInfo?returnUrl={returnUrl}&generateState={generateState}	No documentation available.
POST ChangePassword	No documentation available.
POST SetPassword	No documentation available.
POST AddExternalLogin	No documentation available.
POST RemoveLogin	No documentation available.
GET ExternalLogin?provider={provider}&error={error}	No documentation available.
GET ExternalLogins?returnUrl={returnUrl}&generateState={generateState}	No documentation available.
GET Login?Username={Username}&Password={Password}	No documentation available.
GET LoginByIDNumber?IDNumber={IDNumber}&Password={Password}	No documentation available.
GET LoginByCellNumber?PhoneNumber={PhoneNumber}&Password={Password}	No documentation available.
GET GetPendingBalance?UserId={UserId}	No documentation available.
GET GetUserAccountBalance?UserId={UserId}	No documentation available.
POST UpdateUser?UserId={UserId}	No documentation available.
POST UpdatePassword?UserId={UserId}	No documentation available.
POST Register	No documentation available.
POST RegisterExternal	No documentation available.
GET CheckUserExists?email={email}&phoneNumber={phoneNumber}&idNumber={idNumber}	No documentation available.
GET TestPhoneNormalization?phoneNumber={phoneNumber}	No documentation available.

companybanks

API	Description
GET api/companybanks/single	No documentation available.
GET api/companybanks	No documentation available.
PUT api/companybanks/{id}	No documentation available.
POST api/companybanks	No documentation available.
DELETE api/companybanks/{id}	No documentation available.

transactionhistory

API	Description
GET GetClientId?TransActionId={TransActionId}	No documentation available.
GET GettransactionhistoryByTransactionRef?reference={reference}	No documentation available.
GET GetRefundtransactionhistory?UserId={UserId}	No documentation available.
GET api/transactionhistory	No documentation available.
GET api/transactionhistory/{id}	No documentation available.
PUT api/transactionhistory/{id}	No documentation available.
POST api/transactionhistory	No documentation available.
DELETE api/transactionhistory/{id}	No documentation available.

SuperAdmin

API	Description
GET api/superadmin/vendors/pending-kyc	No documentation available.
GET api/superadmin/vendors/{vendorId}/kyc-details	No documentation available.
POST api/superadmin/vendors/{vendorId}/approve	No documentation available.
POST api/superadmin/vendors/{vendorId}/reject	No documentation available.
POST api/superadmin/vendors/documents/{documentId}/verify	No documentation available.
GET api/superadmin/vendors/all?status={status}&kycVerified={kycVerified}	No documentation available.
POST api/superadmin/vendors/{vendorId}/suspend	No documentation available.
POST api/superadmin/vendors/{vendorId}/reactivate	No documentation available.
GET api/superadmin/settings/company	No documentation available.
PUT api/superadmin/settings/company	No documentation available.
GET api/superadmin/settings/api-keys	No documentation available.
POST api/superadmin/settings/api-keys	No documentation available.
DELETE api/superadmin/settings/api-keys/{keyId}	No documentation available.
GET api/superadmin/journals?startDate={startDate}&endDate={endDate}&accountType={accountType}&page={page}&pageSize={pageSize}	No documentation available.
GET api/superadmin/journals/{id}	No documentation available.
GET api/superadmin/transactions/history?startDate={startDate}&endDate={endDate}&userId={userId}&vendorId={vendorId}&transactionType={transactionType}&page={page}&pageSize={pageSize}	No documentation available.
GET api/superadmin/transactions/statistics?startDate={startDate}&endDate={endDate}	No documentation available.
GET api/superadmin/audit-trail?startDate={startDate}&endDate={endDate}&userId={userId}&action={action}&entityType={entityType}&page={page}&pageSize={pageSize}	No documentation available.
GET api/superadmin/audit-trail/actions	No documentation available.
GET api/superadmin/audit-trail/entity-types	No documentation available.
GET api/superadmin/dashboard/statistics	No documentation available.
GET api/superadmin/dashboard/health-check	No documentation available.
GET api/superadmin/users?active={active}&isMerchant={isMerchant}&page={page}&pageSize={pageSize}	No documentation available.
POST api/superadmin/users/{userId}/suspend	No documentation available.
POST api/superadmin/users/{userId}/reactivate	No documentation available.
GET api/superadmin/roles	No documentation available.
POST api/superadmin/users/{userId}/assign-role	No documentation available.
POST api/superadmin/users/{userId}/remove-role	No documentation available.

stocklists

API	Description
GET GetProductName?UserId={UserId}&ProductId={ProductId}	No documentation available.
GET GetStockDataBymerchantid?UserId={UserId}	No documentation available.
POST ModifyStock	No documentation available.
POST AddStock	No documentation available.
GET api/stocklists	No documentation available.
GET api/stocklists/{id}	No documentation available.
PUT api/stocklists/{id}	No documentation available.
DELETE api/stocklists/{id}	No documentation available.

vendordocuments

API	Description
GET DeleteMerchantDocument?id={id}&VendorId={VendorId}	No documentation available.
GET GetRecordsByVendorId?vendorid={vendorid}	No documentation available.
POST uploadmerchantdocument	No documentation available.

useraccountfundings

API	Description
POST CreateUserAccountFunding	No documentation available.
GET GetPendingUserAccountFunding?UserId={UserId}	No documentation available.
GET GetFundingDataUserAccountFunding?TransactionRef={TransactionRef}	No documentation available.
POST CancelUserAccountFunding?id={id}&UserId={UserId}	No documentation available.
POST CancelUserAccountFunding?TransactionRef={TransactionRef}	No documentation available.
GET GetProcessedUserAccountFunding?UserId={UserId}	No documentation available.
GET GetUserAccountFundingUpdates?UserId={UserId}	No documentation available.

purchasehistories

API	Description
GET CheckTransactionStatus?TransactionRef={TransactionRef}	No documentation available.
GET ResetTransactionStatus?TransactionRef={TransactionRef}	No documentation available.
GET GetpurchasehistoryByTransactionRef?TransactionRef={TransactionRef}	No documentation available.
GET GetVendortransactionhistoryByOperator?merchantid={merchantid}&OperatorId={OperatorId}	No documentation available.
GET GetVendortransactionhistory?merchantid={merchantid}	No documentation available.
GET GetpurchasehistoryByClientId?ClientId={ClientId}	No documentation available.
POST TransactPurchase?id={id}	No documentation available.
POST RefundPurchase	No documentation available.
POST AddPurchaseHistory	No documentation available.
GET api/purchasehistories	No documentation available.
GET api/purchasehistories/{id}	No documentation available.
DELETE api/purchasehistories/{id}	No documentation available.

FundingDocuments

API	Description
GET DeleteDocument?Userid={Userid}&transactionRef={transactionRef}	No documentation available.
GET DeleteDocument?Userid={Userid}&Id={Id}	No documentation available.
GET GetRecordsByUserandTransactionId?userId={userId}&TransactionRef={TransactionRef}	No documentation available.
POST uploadfundingdocument	No documentation available.

purchaserefundrequests

API	Description
POST ValidatePurchaseRefund?TransactionReference={TransactionReference}	No documentation available.
POST CreatePuchaseRefundRequest	No documentation available.
GET api/purchaserefundrequests	No documentation available.
GET api/purchaserefundrequests/{id}	No documentation available.
PUT api/purchaserefundrequests/{id}	No documentation available.
POST api/purchaserefundrequests	No documentation available.
DELETE api/purchaserefundrequests/{id}	No documentation available.

sendrequests

API	Description
GET GetSendRequest?TransactionReference={TransactionReference}	No documentation available.
GET CheckUserBalance?userId={userId}&amountToCheck={amountToCheck}	No documentation available.
POST ValidateUserFunds	No documentation available.
POST AcceptIncomingPayment	No documentation available.
POST ReceivedSendRequest?TransactionReference={TransactionReference}	No documentation available.
POST CreateSendRequest	No documentation available.

refundhistories

API	Description
GET GetrefundhistoryByUserId?UserId={UserId}	No documentation available.
POST Insertrefundhistory	No documentation available.
GET api/refundhistories	No documentation available.
GET api/refundhistories/{id}	No documentation available.
PUT api/refundhistories/{id}	No documentation available.
POST api/refundhistories	No documentation available.
DELETE api/refundhistories/{id}	No documentation available.

withdrawrequests

API	Description
POST CreateWithdrawRequest	No documentation available.

InAppNotifications

API	Description
GET api/InAppNotifications/GetUserNotifications/{userId}?pageSize={pageSize}&pageNumber={pageNumber}	No documentation available.
GET api/InAppNotifications/GetUnreadNotifications/{userId}	No documentation available.
GET api/InAppNotifications/GetUnreadCount/{userId}	No documentation available.
POST api/InAppNotifications/MarkAsRead/{notificationId}	No documentation available.
POST api/InAppNotifications/MarkAllAsRead/{userId}	No documentation available.
POST api/InAppNotifications/CreateNotification	No documentation available.
DELETE api/InAppNotifications/DeleteNotification/{notificationId}	No documentation available.
DELETE api/InAppNotifications/DeleteAllRead/{userId}	No documentation available.

purchaseitemshistories

API	Description
GET IsTransactionItem?TransactionRef={TransactionRef}	No documentation available.
GET GetpurchaseitemshistoryByRef?reference={reference}	No documentation available.
GET GetpurchaseitemshistoryByUserId?userId={userId}	No documentation available.
POST Uploadpurchaseitemshistory	No documentation available.
GET api/purchaseitemshistories	No documentation available.
GET api/purchaseitemshistories/{id}	No documentation available.
PUT api/purchaseitemshistories/{id}	No documentation available.
POST api/purchaseitemshistories	No documentation available.
DELETE api/purchaseitemshistories/{id}	No documentation available.

pushnotifications

API	Description
POST Sendpushnotification	No documentation available.
GET api/pushnotifications	No documentation available.
GET api/pushnotifications/{id}	No documentation available.
PUT api/pushnotifications/{id}	No documentation available.
DELETE api/pushnotifications/{id}	No documentation available.

Notifications

API	Description
POST QueueSmsNotification	No documentation available.
POST QueueEmailNotification	No documentation available.

Health

API	Description
GET api/health/notifications	No documentation available.
POST api/health/notifications/reset-tokens	No documentation available.

refunditemshistories

API	Description
GET GetrefunditemshistoryByUserId?userId={userId}	No documentation available.
POST InsertDatarefunditemshistory	No documentation available.
GET api/refunditemshistories	No documentation available.
GET api/refunditemshistories/{id}	No documentation available.
PUT api/refunditemshistories/{id}	No documentation available.
POST api/refunditemshistories	No documentation available.
DELETE api/refunditemshistories/{id}	No documentation available.

transactions

API	Description
GET GettransactionhistoryByUserId?UserId={UserId}	No documentation available.
POST addtransactions	No documentation available.
GET api/transactions	No documentation available.
GET api/transactions/{id}	No documentation available.
PUT api/transactions/{id}	No documentation available.
DELETE api/transactions/{id}	No documentation available.

ProductBarcodes

API	Description
POST UpdateUUID	No documentation available.
GET GetToken?Username={Username}	No documentation available.
GET GetUUID?Username={Username}	No documentation available.
POST UpdateToken	No documentation available.
GET GetProductBarcodeBymerchantidAndProductId?UserId={UserId}&ProductId={ProductId}	No documentation available.
GET GetProductBarcodeBymerchantidAndBarcode?UserId={UserId}&Barcode={Barcode}	No documentation available.

vendors

API	Description
GET GetCompanyById?id={id}	No documentation available.
GET GetCompanyByUserId?UserId={UserId}	No documentation available.
POST UpdateCompanyDetails	No documentation available.
POST UpdateCompanyProfileWithReVerification	No documentation available.
POST UpdateCompanyLogo	No documentation available.
POST AddCompanyInfo	No documentation available.
GET api/vendors	No documentation available.
DELETE api/vendors/{id}	No documentation available.

Loyalty

API	Description
POST loyalty/calculate-cashback	No documentation available.
GET loyalty/user/{userId}	No documentation available.
GET loyalty/monthly-summary/{userId}/{month}/{year}	No documentation available.
GET loyalty/monthly-summaries/{userId}	No documentation available.
POST loyalty/process-monthly	No documentation available.
GET loyalty/settings	No documentation available.
PUT loyalty/settings	No documentation available.
GET loyalty/lifetime/{userId}	No documentation available.
GET loyalty/accounts/{userId}	No documentation available.
GET loyalty/accounts/{userId}/points/transactions?top={top}	No documentation available.
GET loyalty/accounts/{userId}/cashback/transactions?top={top}	No documentation available.
POST loyalty/accounts/convert-points	No documentation available.

refundhistorys

API	Description
GET api/refundhistorys	No documentation available.
GET api/refundhistorys/{id}	No documentation available.
PUT api/refundhistorys/{id}	No documentation available.
DELETE api/refundhistorys/{id}	No documentation available.

Values

API	Description
GET api/Values	No documentation available.
GET api/Values/{id}	No documentation available.
POST api/Values	No documentation available.
PUT api/Values/{id}	No documentation available.
DELETE api/Values/{id}	No documentation available.

transactionitems

API	Description
GET api/transactionitems	No documentation available.
GET api/transactionitems/{id}	No documentation available.
PUT api/transactionitems/{id}	No documentation available.
POST api/transactionitems	No documentation available.
DELETE api/transactionitems/{id}	No documentation available.