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

TransferStatus

data class TransferStatus(val amount: String? = null, val currency: String? = null, val financialTransactionId: String? = null, val externalId: String? = null, val payee: Party? = null, val payerMessage: String? = null, val payeeNote: String? = null, val status: StatusTypes? = null, val reason: ErrorResponse? = null)

Represents the status of a transfer, returned by getTransferStatus (GET /{productType}/{apiVersion}/transfer/{referenceId}).

status is the typed StatusTypes enum (PENDING, SUCCESSFUL, or FAILED for this endpoint), payee reuses the Party model, and reason reuses ErrorResponse (code and message) rather than redeclaring those shapes. Every field is optional so partial payloads never break deserialization.

Constructors

Link copied to clipboard
constructor(amount: String? = null, currency: String? = null, financialTransactionId: String? = null, externalId: String? = null, payee: Party? = null, payerMessage: String? = null, payeeNote: String? = null, status: StatusTypes? = null, reason: ErrorResponse? = null)

Properties

Link copied to clipboard
val amount: String?

The amount transferred to the payee account.

Link copied to clipboard
val currency: String?

The ISO 4217 currency code for the transaction.

Link copied to clipboard
val externalId: String?

The external id used as a reference for reconciliation; need not be unique.

Link copied to clipboard
val financialTransactionId: String?

The financial transaction id from the mobile money manager, connecting to the specific financial transaction made in the account.

Link copied to clipboard
val payee: Party?

The Party credited by the transfer.

Link copied to clipboard
val payeeNote: String?

The note written to the payee's transaction history.

Link copied to clipboard
val payerMessage: String?

The message written to the payer's transaction history.

Link copied to clipboard
val reason: ErrorResponse?

The failure reason (code and message) when the transfer did not succeed.

Link copied to clipboard
val status: StatusTypes?

The transfer lifecycle status.

Generated by Dokka
© Re.Kast Limited