PayFanout API reference
    Preparing search index...

    Interface RefundInfo

    Snapshot returned by retrieveRefund — refundPayment can come back "pending" (async refunds), and this is how the host polls it to a terminal state.

    interface RefundInfo {
        amount: number;
        createdAt?: string;
        pspPaymentId?: string;
        raw: unknown;
        refundId: string;
        status: "succeeded" | "failed" | "pending";
    }

    Hierarchy (View Summary)

    Index
    amount createdAt? pspPaymentId? raw refundId status
    amount: number
    createdAt?: string

    ISO 8601, when known.

    pspPaymentId?: string

    The PSP payment the refund belongs to, when the PSP reports it.

    raw: unknown
    refundId: string
    status: "succeeded" | "failed" | "pending"

    Settings
    Member Visibility

    On This Page
    Properties