Interface CheckoutResult

Provider-neutral result of one checkout attempt.

interface CheckoutResult {
    outcome: CheckoutOutcome;
    paymentMethod?: "card" | null;
    providerPaymentReference?: string | null;
    providerReference: string | null;
}

Properties

Outcome class the application acts on.

paymentMethod?: "card" | null

Neutral method used for the confirmed charge, or null when unavailable.

providerPaymentReference?: string | null

Provider payment-level reference when available. It is separate from the provider order reference and is required by some refund protocols.

providerReference: string | null

Stable provider reference when the provider supplied one, otherwise null.

A reference proves that an attempt exists; it is never proof that money was captured, and its presence never changes the outcome class.