momo-api-sdk/io.rekast.sdk.repository/DefaultSource

DefaultSource

class DefaultSource @Inject constructor(authenticationService: AuthenticationService, commonService: CommonService, collectionService: CollectionService, remittanceService: RemittanceService)

DefaultSource is responsible for handling API calls related to user management and authentication in the MTN MOMO SDK.

This class acts as a bridge between the repository and the authentication service, providing methods to create API users, retrieve user details, create API keys, and obtain access tokens.

Constructors

DefaultSource

@Inject

constructor(authenticationService: AuthenticationService, commonService: CommonService, collectionService: CollectionService, remittanceService: RemittanceService)

Functions

bcAuthorize

suspend fun bcAuthorize(productType: String, apiVersion: String, bcAuthorizeRequest: BcAuthorizeRequest, productSubscriptionKey: String, environment: String): Response<BackChannelAuthorize>

Initiates a backchannel (CIBA) authorization request.

cancelInvoice

suspend fun cancelInvoice(referenceId: String, apiVersion: String, productSubscriptionKey: String, environment: String): Response<Unit>

Cancels a pending Collection invoice.

cancelPreApproval

suspend fun cancelPreApproval(referenceId: String, apiVersion: String, productSubscriptionKey: String, environment: String): Response<Unit>

Cancels an active Collection pre-approval.

cashTransfer

suspend fun cashTransfer(cashTransfer: CashTransfer, apiVersion: String, productSubscriptionKey: String, environment: String, uuid: String): Response<Unit>

Initiates a Remittance cash transfer using the V2 endpoint with optional KYC fields.

createApiKey

suspend fun createApiKey(apiVersion: String, userId: String, productSubscriptionKey: String): Response<ApiKey>

Creates a new API key for the specified API user.

createApiUser

suspend fun createApiUser(providerCallBackHost: ProviderCallBackHost, apiVersion: String, uuid: String, productSubscriptionKey: String): Response<ApiUser>

Creates a new API user.

createInvoice

suspend fun createInvoice(invoice: Invoice, apiVersion: String, productSubscriptionKey: String, environment: String, uuid: String): Response<Unit>

Creates a Collection invoice.

createPreApproval

suspend fun createPreApproval(preApproval: PreApproval, apiVersion: String, productSubscriptionKey: String, environment: String, uuid: String): Response<Unit>

Creates a Collection pre-approval, authorising the merchant to charge the payer's wallet without per-transaction prompts until the pre-approval expires.

getAccessToken

suspend fun getAccessToken(productType: String, productSubscriptionKey: String): Response<AccessToken>

Obtains an access token for the specified product type.

getAccountBalance

suspend fun getAccountBalance(productType: String, apiVersion: String, productSubscriptionKey: String, environment: String): Response<AccountBalance>

Retrieves the account balance for a specified product type. This only works with the ProductType.COLLECTION. It seems to break with the other API product type.

getAccountBalanceInSpecificCurrency

suspend fun getAccountBalanceInSpecificCurrency(productType: String, apiVersion: String, currency: String, productSubscriptionKey: String, environment: String): Response<AccountBalance>

Retrieves the account balance in a specific currency. This only works with the ProductType.COLLECTION. It seems to break with the other API product type.

getApiUser

suspend fun getApiUser(apiVersion: String, userId: String, productSubscriptionKey: String): Response<ApiUser>

Retrieves the details of an existing API user.

getBasicUserInfo

suspend fun getBasicUserInfo(productType: String, apiVersion: String, accountHolder: String, productSubscriptionKey: String, environment: String): Response<BasicUserInfo>

Retrieves the basic user information for a specified MTN MOMO user.

getCashTransferStatus

suspend fun getCashTransferStatus(referenceId: String, apiVersion: String, productSubscriptionKey: String, environment: String): Response<ERROR CLASS: Symbol not found for ResponseBody>

Retrieves the status of a previously initiated Remittance cash transfer.

getInvoiceStatus

suspend fun getInvoiceStatus(referenceId: String, apiVersion: String, productSubscriptionKey: String, environment: String): Response<ERROR CLASS: Symbol not found for ResponseBody>

Retrieves the status of a previously created Collection invoice.

getOauth2AccessToken

suspend fun getOauth2AccessToken(productType: String, productSubscriptionKey: String, environment: String, backChannelAuthorizationRequestId: String): Response<Oauth2AccessToken>

Retrieves an OAuth2 access token for the specified product type.

getPreApprovalStatus

suspend fun getPreApprovalStatus(referenceId: String, apiVersion: String, productSubscriptionKey: String, environment: String): Response<ERROR CLASS: Symbol not found for ResponseBody>

Retrieves the status of a previously created Collection pre-approval.

getTransferStatus

suspend fun getTransferStatus(productType: String, apiVersion: String, referenceId: String, productSubscriptionKey: String, environment: String): Response<ERROR CLASS: Symbol not found for ResponseBody>

Retrieves the status of a transfer for a specified product type.

getUserInfoWithConsent

suspend fun getUserInfoWithConsent(productType: String, apiVersion: String, productSubscriptionKey: String, environment: String): Response<UserInfoWithConsent>

Retrieves user information with consent for a specified product type.

requestToPayDeliveryNotification

suspend fun requestToPayDeliveryNotification(productType: String, apiVersion: String, referenceId: String, momoNotification: MomoNotification, productSubscriptionKey: String, environment: String): Response<ERROR CLASS: Symbol not found for ResponseBody>

Sends a delivery notification for a request to pay.

requestToWithdrawDeliveryNotification

suspend fun requestToWithdrawDeliveryNotification(apiVersion: String, referenceId: String, momoNotification: MomoNotification, productSubscriptionKey: String, environment: String): Response<ERROR CLASS: Symbol not found for ResponseBody>

Sends a delivery notification for a request-to-withdraw transaction.

transfer

suspend fun transfer(productType: String, apiVersion: String, momoTransaction: MomoTransaction, uuid: String, productSubscriptionKey: String, environment: String): Response<Unit>

Initiates a transfer for a specified product type.

validateAccountHolderStatus

suspend fun validateAccountHolderStatus(productType: String, apiVersion: String, accountHolder: AccountHolder, productSubscriptionKey: String, environment: String): Response<ERROR CLASS: Symbol not found for ResponseBody>

Validates the status of an account holder.