Beignet API reference
    Preparing search index...

    Interface Refund

    Refund returned by a payment provider.

    interface Refund {
        amount?: number;
        currency?: string;
        id: string;
        metadata?: PaymentMetadata;
        paymentId: string;
        provider: string;
        raw?: unknown;
        status?: string;
    }
    Index
    amount? currency? id metadata? paymentId provider raw? status?
    amount?: number

    Refunded amount in the provider's smallest currency unit, when known.

    currency?: string

    Currency code, when known.

    id: string

    Provider refund ID.

    metadata?: PaymentMetadata

    Provider metadata.

    paymentId: string

    Provider payment ID that was refunded.

    provider: string

    Provider name.

    raw?: unknown

    Raw provider response for app-owned escape hatches.

    status?: string

    Provider refund status, when known.

    Settings
    Member Visibility

    On This Page
    Properties