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

DefaultRepository

@Singleton

class DefaultRepository @Inject constructor(defaultSource: DefaultSource, disbursementsService: DisbursementsService, collection: CollectionService, config: ApiConfig) : DataResponse

The DefaultRepository class is responsible for making network calls to the MTN MOMO APIs.

This class holds all the common API methods for various MTN MOMO products, including user management, transaction processing, and status checks.

Constructors

DefaultRepository

@Inject

constructor(defaultSource: DefaultSource, disbursementsService: DisbursementsService, collection: CollectionService, config: ApiConfig)

Functions

bcAuthorize

fun bcAuthorize(productType: String, apiVersion: String, bcAuthorizeRequest: BcAuthorizeRequest, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/BcAuthorizeResponse>>

Initiates a backchannel (CIBA) authorization request.

cancelInvoice

fun cancelInvoice(apiVersion: String, referenceId: String, externalId: String, uuid: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<kotlin/Unit>>

Cancels a pending Collection invoice before it is paid or expires.

cancelPreApproval

fun cancelPreApproval(apiVersion: String, referenceId: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<kotlin/Unit>>

Cancels an active Collection pre-approval, immediately revoking the merchant's ability to debit the payer's wallet without per-transaction consent.

cashTransfer

fun cashTransfer(apiVersion: String, cashTransfer: CashTransfer, uuid: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<kotlin/Unit>>

Initiates a Remittance cash transfer using the V2 endpoint with optional KYC fields about the sending party. This replaces the legacy V1 transfer for cross-border remittance use cases where the sender is not a registered MTN mobile money subscriber.

checkApiUser

fun checkApiUser(apiVersion: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/authentication/ApiUser>>

Checks whether the supplied API user exists.

createApiKey

fun createApiKey(apiVersion: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/authentication/ApiKey>>

Gets the API Key based on the ApiUser Id and OCP Subscription Id.

createApiUser

fun createApiUser(providerCallBackHost: ProviderCallBackHost, apiVersion: String, uuid: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/authentication/ApiUser>>

Creates a new API user.

createInvoice

fun createInvoice(apiVersion: String, invoice: Invoice, uuid: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<kotlin/Unit>>

Creates a Collection invoice, prompting the intended payer to approve payment from their wallet.

createPayment

fun createPayment(apiVersion: String, payment: Payment, uuid: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<kotlin/Unit>>

Creates a Collection payment (V2). Poll getPaymentStatus with the same uuid as the reference ID to check the outcome.

createPreApproval

fun createPreApproval(apiVersion: String, preApproval: PreApproval, uuid: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<kotlin/Unit>>

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

deposit

fun deposit(deposit: Deposit, apiVersion: String, productSubscriptionKey: String, uuid: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<kotlin/Unit>>

Initiates a deposit via the Disbursements service, sending funds to the payee.

getAccessToken

fun getAccessToken(productSubscriptionKey: String, productType: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/authentication/AccessToken>>

Gets the Access Token based on the ApiUser ID, OCP Subscription Id, and the API Key.

getAccountBalance

fun getAccountBalance(productType: String, apiVersion: String, currency: String?, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/AccountBalance>>

Retrieves the account balance, optionally filtered by currency.

getApprovedPreApprovals

fun getApprovedPreApprovals(apiVersion: String, accountHolderIdType: String, accountHolderId: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/ApprovedPreApprovals>>

Retrieves the list of approved pre-approvals for a given account holder.

getBasicUserInfo

fun getBasicUserInfo(productType: String, apiVersion: String, accountHolder: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/BasicUserInfo>>

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

getCashTransferStatus

fun getCashTransferStatus(apiVersion: String, referenceId: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/CashTransferStatus>>

Retrieves the status of a previously initiated Remittance cash transfer.

getDepositStatus

fun getDepositStatus(referenceId: String, apiVersion: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/DepositStatus>>

Retrieves the status of a previously initiated deposit transaction.

getInvoiceStatus

fun getInvoiceStatus(apiVersion: String, referenceId: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/InvoiceStatus>>

Retrieves the current status of a previously created Collection invoice.

getOauthAccessToken

fun getOauthAccessToken(productType: String, productSubscriptionKey: String, backChannelAuthorizationRequestId: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/authentication/Oauth2AccessToken>>

Obtains an OAuth2 access token for use with consent-based API endpoints.

getPaymentStatus

fun getPaymentStatus(apiVersion: String, referenceId: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/PaymentStatus>>

Retrieves the current status of a previously created Collection payment.

getPreApprovalStatus

fun getPreApprovalStatus(apiVersion: String, referenceId: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/PreApprovalStatus>>

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

getRefundStatus

fun getRefundStatus(referenceId: String, apiVersion: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/RefundStatus>>

Retrieves the status of a previously initiated refund transaction.

getTransferStatus

fun getTransferStatus(productType: String, apiVersion: String, referenceId: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/TransferStatus>>

Retrieves the status of a previously initiated fund transfer.

getUserInfoWithConsent

fun getUserInfoWithConsent(productType: String, apiVersion: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/UserInfoWithConsent>>

Retrieves extended user information for a MTN MOMO user who has granted consent.

refund

fun refund(refund: Refund, apiVersion: String, productSubscriptionKey: String, uuid: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<kotlin/Unit>>

Initiates a refund via the Disbursements service, reversing a previous transaction.

requestToPay

fun requestToPay(requestToPay: RequestToPay, apiVersion: String, productSubscriptionKey: String, uuid: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<kotlin/Unit>>

Initiates a request-to-pay via the Collection service, prompting the payer to approve a debit.

requestToPayDeliveryNotification

fun requestToPayDeliveryNotification(productType: String, apiVersion: String, referenceId: String, notifications: Notifications, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<ERROR CLASS: Symbol not found for ResponseBody>>

Sends a delivery notification to the payer for an existing request-to-pay transaction.

requestToPayTransactionStatus

fun requestToPayTransactionStatus(referenceId: String, apiVersion: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/RequestToPayStatus>>

Retrieves the status of a previously initiated request-to-pay transaction.

requestToWithdraw

fun requestToWithdraw(requestToWithdraw: RequestToWithdraw, apiVersion: String, productSubscriptionKey: String, uuid: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<kotlin/Unit>>

Initiates a request-to-withdraw via the Collection service, prompting the payer to approve a debit.

requestToWithdrawTransactionStatus

fun requestToWithdrawTransactionStatus(referenceId: String, apiVersion: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/RequestToWithdrawStatus>>

Retrieves the status of a previously initiated request-to-withdraw transaction.

safeApiCall

suspend fun <T> safeApiCall(apiRequest: suspend () -> Response<T>): NetworkResult<T>

Safely makes an API call and returns the result.

transfer

fun transfer(productType: String, apiVersion: String, transfer: Transfer, uuid: String, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<kotlin/Unit>>

Initiates a fund transfer to a specified account.

validateAccountHolderStatus

fun validateAccountHolderStatus(productType: String, apiVersion: String, party: Party, productSubscriptionKey: String): ERROR CLASS: Symbol not found for Flow<io/rekast/sdk/repository/data/NetworkResult<io/rekast/sdk/model/AccountHolderStatus>>

Validates whether the specified account holder is active in the MTN MOMO system.