PreApprovalStatus

data class PreApprovalStatus(val payer: Party? = null, val payerCurrency: String? = null, val payerMessage: String? = null, val status: StatusTypes? = null, val expirationDateTime: Long? = null, val reason: ErrorResponse? = null)

Represents the status of a single Collection pre-approval, returned by getPreApprovalStatus.

status is the typed StatusTypes enum (PENDING, SUCCESSFUL, FAILED). Reuses Party for payer and ErrorResponse for the reason object (both code and message) rather than redeclaring those shapes. Every field is optional so partial payloads never break deserialization.

Constructors

Link copied to clipboard
constructor(payer: Party? = null, payerCurrency: String? = null, payerMessage: String? = null, status: StatusTypes? = null, expirationDateTime: Long? = null, reason: ErrorResponse? = null)

Properties

Link copied to clipboard

The expiry as an epoch value; 0 when not set.

Link copied to clipboard
val payer: Party?

The account holder that authorised the pre-approval.

Link copied to clipboard

The ISO 4217 currency of the payer's account.

Link copied to clipboard

The message shown to the payer.

Link copied to clipboard

The failure reason (code and message) when the pre-approval was not approved.

Link copied to clipboard

The pre-approval status (PENDING, SUCCESSFUL, or FAILED).