RequestToWithdraw

data class RequestToWithdraw(val amount: String, val currency: String, val externalId: String, val payer: Party? = null, val payee: Party? = null, val payerMessage: String, val payeeNote: String)

Request body for the Collection request-to-withdraw operation, prompting the payer to approve a withdrawal.

Constructors

Link copied to clipboard
constructor(amount: String, currency: String, externalId: String, payer: Party? = null, payee: Party? = null, payerMessage: String, payeeNote: String)

Properties

Link copied to clipboard

The amount that will be debited from the payer account.

Link copied to clipboard

The ISO 4217 currency code.

Link copied to clipboard

A caller-assigned reference used for reconciliation; need not be unique.

Link copied to clipboard
val payee: Party?

Unused for this operation.

Link copied to clipboard

Message written to the payee's transaction history.

Link copied to clipboard
val payer: Party?

The sending party prompted to approve the withdrawal.

Link copied to clipboard

Message written to the payer's transaction history.