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

RemittanceService

sealed interface RemittanceService : CommonService

Retrofit service interface for the MTN MOMO Remittance product API.

Extends CommonService with remittance-specific operations: the V1 transfer and cash transfer V2.

Functions

@POST(value = "/remittance/{apiVersion}/cashtransfer")

abstract suspend fun cashTransfer(@Body cashTransfer: CashTransfer, @Path(value = "apiVersion") apiVersion: String, @Header(value = "Ocp-Apim-Subscription-Key") productSubscriptionKey: String, @Header(value = "X-Reference-Id") uuid: String): Response<Unit>

Initiates a remittance cash transfer using the V2 endpoint, which supports extended KYC fields for cross-border compliance where the sender is not an MTN mobile money subscriber.

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.

getCashTransferStatus

@GET(value = "/remittance/{apiVersion}/cashtransfer/{referenceId}")

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

Retrieves the status of a previously initiated cash transfer.

getTransferStatus

@GET(value = "/{productType}/{apiVersion}/transfer/{referenceId}")

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

Makes a request to get the transfer status.

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.

transfer

@POST(value = "/{productType}/{apiVersion}/transfer")

abstract suspend fun transfer(@Path(value = "productType") productType: String, @Path(value = "apiVersion") apiVersion: String, @Body transfer: Transfer, @Header(value = "X-Reference-Id") uuid: String, @Header(value = "Ocp-Apim-Subscription-Key") productSubscriptionKey: String): Response<Unit>

Makes a request to transfer funds (Remittance V1).

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.