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

RequestToWithdrawStatus

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

Represents the status of a Collection request-to-withdraw, returned by requestToWithdrawTransactionStatus (GET /collection/{apiVersion}/requesttowithdraw/{referenceId}).

status is the typed StatusTypes enum (PENDING, SUCCESSFUL, or FAILED for this endpoint), payer 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, payer: Party? = null, payerMessage: String? = null, payeeNote: String? = null, status: StatusTypes? = null, reason: ErrorResponse? = null)

Properties

Link copied to clipboard
val amount: String?

The amount debited from the payer 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 provided when the request-to-withdraw transaction was created.

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 payeeNote: String?

The note written to the payee's transaction history.

Link copied to clipboard
val payer: Party?

The Party prompted to approve the withdrawal.

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 request-to-withdraw did not succeed.

Link copied to clipboard
val status: StatusTypes?

The request-to-withdraw lifecycle status.

Generated by Dokka
© Re.Kast Limited