CashTransferStatus

data class CashTransferStatus(val financialTransactionId: String? = null, val status: String? = null, val reason: String? = null, val amount: String? = null, val currency: String? = null, val payee: Party? = null, val externalId: String? = null, val originatingCountry: String? = null, val originalAmount: String? = null, val originalCurrency: String? = null, val payerMessage: String? = null, val payeeNote: String? = null, val payerIdentificationType: PayerIdentificationType? = 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)

Represents the status of a Remittance cash transfer, returned by getCashTransferStatus (GET /remittance/{apiVersion}/cashtransfer/{referenceId}).

Mirrors the CashTransfer request payload and adds the outcome fields financialTransactionId, status, and reason. status and reason are plain strings here (the endpoint returns a bare status string and an error string), and payerIdentificationType reuses PayerIdentificationType. Every field is optional so partial payloads never break deserialization.

Constructors

Link copied to clipboard
constructor(financialTransactionId: String? = null, status: String? = null, reason: String? = null, amount: String? = null, currency: String? = null, payee: Party? = null, externalId: String? = null, originatingCountry: String? = null, originalAmount: String? = null, originalCurrency: String? = null, payerMessage: String? = null, payeeNote: String? = null, payerIdentificationType: PayerIdentificationType? = null, payerIdentificationNumber: String? = null, payerIdentity: String? = null, payerFirstName: String? = null, payerSurName: String? = null, payerLanguageCode: String? = null, payerEmail: String? = null, payerMsisdn: String? = null, payerGender: String? = null)

Properties

Link copied to clipboard

The transfer amount.

Link copied to clipboard

The ISO 4217 currency code for the transaction.

Link copied to clipboard

Merchant-assigned reference used to correlate the transfer for reconciliation.

Link copied to clipboard

The transaction id of the cash transfer from the mobile money manager.

Link copied to clipboard

The amount in the originating currency before conversion.

Link copied to clipboard

ISO 4217 currency code of the originating amount.

Link copied to clipboard

ISO country code of the country from which the funds originate. Serialized as orginatingCountry to match the (misspelled) MTN MOMO API field name.

Link copied to clipboard
val payee: Party?

The Party receiving the funds.

Link copied to clipboard

A note visible to the payee describing the purpose of the transfer.

Link copied to clipboard

Email address of the sending party.

Link copied to clipboard

First name of the sending party.

Link copied to clipboard

Gender code of the sending party.

Link copied to clipboard

The identification document number matching payerIdentificationType.

Link copied to clipboard

Type of identification document (see PayerIdentificationType).

Link copied to clipboard

The identity number of the sending party (payer).

Link copied to clipboard

ISO 639-1 two-letter language code for the payer (e.g., "en").

Link copied to clipboard

A message visible to the payer describing the purpose of the transfer.

Link copied to clipboard

Phone number of the sending party.

Link copied to clipboard

Surname of the sending party.

Link copied to clipboard

The error description when the cash transfer did not succeed.

Link copied to clipboard

The status of the cash transfer (e.g., PENDING, SUCCESSFUL, FAILED).