momo-api-sdk/io.rekast.sdk.network.service.products/CommonService

CommonService

This is the Retrofit interface to handle various calls to the Shared Product APIs. This interface defines the methods, the request, and the response from the API.

Only operations that are genuinely common across every product (Collection, Disbursements, Remittance) live here — account information and account-holder lookups. Product-specific operations belong to the corresponding product service: transfer lives in RemittanceService and request-to-pay delivery notifications live in CollectionService.

Inheritors

CollectionService

DisbursementsService

RemittanceService

Functions

getAccountBalance

@GET(value = "/{productType}/{apiVersion}/account/balance")

abstract suspend fun getAccountBalance(@Path(value = "productType") productType: String, @Path(value = "apiVersion") apiVersion: String, @Header(value = "Ocp-Apim-Subscription-Key") productSubscriptionKey: String): Response<AccountBalance>

Makes a request to get the Account Balance. This only works with the io.rekast.sdk.utils.ProductTypes.COLLECTION. It seems to break with the other API product type.

getAccountBalanceInSpecificCurrency

@GET(value = "/{productType}/{apiVersion}/account/balance/{currency}")

abstract suspend fun getAccountBalanceInSpecificCurrency(@Path(value = "productType") productType: String, @Path(value = "apiVersion") apiVersion: String, @Path(value = "currency") currency: String, @Header(value = "Ocp-Apim-Subscription-Key") productSubscriptionKey: String): Response<AccountBalance>

Makes a request to get the Account Balance in a specific currency. This only works with the io.rekast.sdk.utils.ProductTypes.COLLECTION. It seems to break with the other API product type. Use EUR as the currency on sandbox

getBasicUserInfo

@GET(value = "/{productType}/{apiVersion}/accountholder/msisdn/{accountHolderId}/basicuserinfo")

abstract suspend fun getBasicUserInfo(@Path(value = "productType") productType: String, @Path(value = "apiVersion") apiVersion: String, @Path(value = "accountHolderId") accountHolder: String, @Header(value = "Ocp-Apim-Subscription-Key") productSubscriptionKey: String): Response<BasicUserInfo>

Makes a request to get the Basic ApiUser Info.

getUserInfoWithConsent

@GET(value = "/{productType}/oauth2/{apiVersion}/userinfo")

abstract suspend fun getUserInfoWithConsent(@Path(value = "productType") productType: String, @Path(value = "apiVersion") apiVersion: String, @Header(value = "Ocp-Apim-Subscription-Key") productSubscriptionKey: String): Response<UserInfoWithConsent>

Makes a request to get the ApiUser Info with Consent.

validateAccountHolderStatus

@GET(value = "/{productType}/{apiVersion}/accountholder/{accountHolderIdType}/{accountHolderId}/active")

abstract suspend fun validateAccountHolderStatus(@Path(value = "productType") productType: String, @Path(value = "apiVersion") apiVersion: String, @Path(value = "accountHolderId") accountHolderId: String, @Path(value = "accountHolderIdType") accountHolderType: String, @Header(value = "Ocp-Apim-Subscription-Key") productSubscriptionKey: String): Response<AccountHolderStatus>

Makes a request to check the account holder status.