momo-api-sdk/io.rekast.sdk.model

Package-level declarations

Types

AccountBalance

data class AccountBalance(var availableBalance: String, var currency: String)

Represents the account balance returned by the MTN MOMO API.

AccountHolder

data class AccountHolder(var partyIdType: String, var partyId: String)

Identifies a party (payer or payee) in a MTN MOMO transaction.

AccountHolderStatus

data class AccountHolderStatus(var result: Boolean)

Represents the active/inactive status of an account holder in the MTN MOMO system.

BackChannelAuthorize

data class BackChannelAuthorize(var authReqId: String, var interval: Int, var expiresIn: Int)

Represents the response from an account authorization request.

BasicUserInfo

data class BasicUserInfo(var sub: String, var name: String, var givenName: String, var familyName: String, var birthDate: String, var locale: String, var gender: String, var updatedAt: Int, var displayUpdatedAt: String = "")

Data class representing basic user information returned by the MTN MOMO API.

BcAuthorizeRequest

data class BcAuthorizeRequest(val loginHint: String, val scope: String, val accessType: String)

Request parameters for a backchannel (CIBA) authorization call.

CashTransfer

data class CashTransfer(val amount: String, val currency: String, val externalId: String, val payee: AccountHolder, val payerMessage: String, val payeeNote: String, val payerIdentificationType: String? = null, val payerIdentificationNumber: String? = null, val payerIdentity: String? = null, val payerFirstName: String? = null, val payerSurName: String? = null, val payerLanguageCode: String? = null, val payerEmail: String? = null, val payerMsisdn: String? = null, val payerGender: String? = null, val originatingCountry: String? = null, val originalAmount: String? = null, val originalCurrency: String? = null)

Represents a Remittance cash transfer request sent to the MTN MOMO Cash Transfer V2 API.

ErrorResponse

data class ErrorResponse(var code: String, var message: String, var error: String)

Represents an error response returned by the MTN MOMO API.

Invoice

data class Invoice(val externalId: String, val amount: String, val currency: String, val validityDuration: String? = null, val intendedPayer: AccountHolder? = null, val payerMessage: String? = null, val payeeNote: String? = null, val description: String? = null)

Represents a Collection invoice request sent to the MTN MOMO Invoice API.

MomoNotification

data class MomoNotification(var notificationMessage: String)

Data class representing a Momo notification.

MomoTransaction

data class MomoTransaction(var amount: String, var currency: String, var financialTransactionId: String? = "", var externalId: String, var payee: AccountHolder? = null, var payer: AccountHolder? = null, var payerMessage: String, var payeeNote: String, var status: String? = "", var reason: String? = "", var referenceIdToRefund: String? = "")

Represents a MTN MOMO transaction used for payments, withdrawals, deposits, transfers, and refunds.

PaymentResult

data class PaymentResult(var merchantRequestID: String, var checkoutRequestID: String, var responseCode: String, var responseDescription: String, var customerMessage: String)

Represents the result returned after initiating a payment request.

PreApproval

data class PreApproval(val payer: AccountHolder, val payerCurrency: String, val payerMessage: String? = null, val validityTime: Int)

Represents a Collection pre-approval request sent to the MTN MOMO Pre-approval API.

ProviderCallBackHost

data class ProviderCallBackHost(val providerCallbackHost: String? = null)

Represents the callback host for the MTN MOMO API.

UserInfoWithConsent

data class UserInfoWithConsent(var sub: String, var name: String, var givenName: String? = null, var familyName: String? = null, var birthDate: String? = null, var locale: String? = null, var gender: String? = null, var updatedAt: Int? = null, var status: String? = null, var middleName: String? = null, var email: String? = null, var emailVerified: Boolean? = null, var phonenumber: String? = null, var phoneNumberVerified: Boolean? = null, var address: String? = null, var creditScore: String? = null, var active: String? = null, var countryOfBirth: String? = null, var regionOfBirth: String? = null, var cityOfBirth: String? = null, var occupation: String? = null, var employerName: String? = null, var identificationType: String? = null, var identificationValue: String? = null)

Represents extended user information returned by the MTN MOMO GET /oauth2/{version}/userinfo endpoint after the user grants consent.