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.

The cash transfer endpoint (/remittance/v2_0/cashtransfer) replaces the legacy V1 transfer for remittance use cases. It extends the standard transfer payload with optional KYC fields about the sending party, enabling cross-border compliance requirements where the payer is not a registered MTN mobile money subscriber.

Constructors

Link copied to clipboard
constructor(amount: String, currency: String, externalId: String, payee: AccountHolder, payerMessage: String, payeeNote: String, payerIdentificationType: String? = 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, originatingCountry: String? = null, originalAmount: String? = null, originalCurrency: String? = null)

Properties

Link copied to clipboard

The transfer amount as a string.

Link copied to clipboard

The ISO 4217 currency code for the transaction (e.g., "EUR", "UGX").

Link copied to clipboard

Merchant-assigned reference used to correlate the transfer on the integrator side.

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.

Link copied to clipboard

The AccountHolder 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 of the sending party.

Link copied to clipboard

The identification document number matching payerIdentificationType.

Link copied to clipboard

Type of identification document; one of CPFA, SRSA, NRIN, OTHR, DRLC, PASS, SOCS, AREG, IDCD.

Link copied to clipboard

The MSISDN 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.