InvoiceStatus

data class InvoiceStatus(val referenceId: String? = null, val externalId: String? = null, val amount: String? = null, val currency: String? = null, val status: StatusTypes? = null, val paymentReference: String? = null, val invoiceId: String? = null, val expiryDateTime: String? = null, val payeeFirstName: String? = null, val payeeLastName: String? = null, val errorReason: ErrorResponse? = null, val intendedPayer: Party? = null, val description: String? = null)

Represents the status of a Collection invoice, returned by getInvoiceStatus.

status is the typed StatusTypes enum, errorReason reuses ErrorResponse (code and message), and intendedPayer reuses Party rather than redeclaring those shapes. Every field is optional so partial payloads never break deserialization.

Constructors

Link copied to clipboard
constructor(referenceId: String? = null, externalId: String? = null, amount: String? = null, currency: String? = null, status: StatusTypes? = null, paymentReference: String? = null, invoiceId: String? = null, expiryDateTime: String? = null, payeeFirstName: String? = null, payeeLastName: String? = null, errorReason: ErrorResponse? = null, intendedPayer: Party? = null, description: String? = null)

Properties

Link copied to clipboard

The invoice amount.

Link copied to clipboard

The ISO 4217 currency used in this invoice.

Link copied to clipboard

An optional description of the invoice.

Link copied to clipboard

The failure reason (code and message) when the invoice did not succeed.

Link copied to clipboard

When the invoice expires, in YYYY-MM-DDTHH:mm:ss format.

Link copied to clipboard

An external transaction id tied to the payment.

Link copied to clipboard

The Party expected to pay the invoice.

Link copied to clipboard

An id for the invoice.

Link copied to clipboard

First name of the payee in this invoice.

Link copied to clipboard

Surname of the payee in this invoice.

Link copied to clipboard

A unique id that identifies a pending invoice.

Link copied to clipboard

The reference id for this invoice.

Link copied to clipboard

The invoice status (CREATED, PENDING, SUCCESSFUL, FAILED).